Skip to main content
POST
Create a webhook subscription

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Body

application/json
url
string<uri>
required
Maximum string length: 2048
eventTypes
string[]
Required array length: 1 - 100 elements
Required string length: 1 - 200

Response

{ success: true, subscription: { id, url, eventTypes, isActive, secret } } — secret nested in subscription, shown once

success
boolean
required
subscription
object
required