Skip to main content
POST
Create a webhook

Authorizations

X-API-Key
string
header
required

Body

application/json

POST /webhooks body. Admin-authored; sender never touches this surface.

definition_id
string
required
description
string
required
Required string length: 1 - 200
mode
enum<string>
default:trigger
Available options:
trigger,
resume
provider
enum<string>
default:standard
Available options:
standard,
stripe,
five9,
custom
input_template
Input Template · object | null
dispatch_retry
Dispatch Retry · object | null
rate_limit
integer | null
Required range: x > 0
enabled
boolean
default:true

Response

Successful Response

POST response — the ONLY place the signing secret + receive URL appear.

Show-once at create (and on explicit rotate); the read model omits both.

id
string
required
definition_id
string
required
org_id
string
required
description
string
required
mode
string
required
provider
string
required
input_template
Input Template · object | null
required
dispatch_retry
Dispatch Retry · object | null
required
rate_limit
integer | null
required
enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
signing_secret
string
required
receive_url
string
required