Skip to main content
POST
Register webhook

Authorizations

Authorization
string
header
required

Your Kynva API key (kyn_live_xxx or kyn_test_xxx; legacy rf_ keys remain valid)

Body

application/json
url
string<uri>
required

The URL to receive webhook POST requests

events
enum<string>[]
required

Array of event types to subscribe to

Minimum array length: 1
Available options:
render.completed,
render.failed,
carousel.completed,
carousel.failed,
brief.received,
batch.completed
name
string

Optional friendly name for this webhook

Maximum string length: 100

Response

201 - application/json

Webhook registered successfully

Webhook registered successfully

success
boolean
data
object