Skip to main content
POST
Create webhook subscription

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Body

application/json

Request to create a webhook subscription.

name
string
required
Required string length: 1 - 255
target_url
string
required
Maximum string length: 2048
event_types
string[]
required
Minimum array length: 1
campaign_id
string<uuid> | null
event_categories
string[] | null

Response

Successful Response

Response after creating a webhook (includes secret shown once).

id
string<uuid>
required
name
string
required
target_url
string
required
workspace_id
string<uuid>
required
event_types
string[]
required
active
boolean
required
secret
string
required
created_at
string<date-time>
required
event_categories
string[] | null
campaign_id
string<uuid> | null