Skip to main content
POST
Create Webhook

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

Idempotency-Key
string | null
X-UI-Organization-ID
string | null

Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet.

Maximum string length: 128

Body

application/json
hook_url
string
required

HTTPS URL to receive completed-interview data

study_id
string | null

Limit delivery to one study; omit for all studies in the account

event_types
enum<string>[]

Events to deliver to this URL

Required array length: 1 - 6 elements
Available options:
interview.completed,
study.completed,
report.ready,
study.paused,
study.resumed,
study.stopped

Response

Successful Response

id
string
required
hook_url
string
required
study_id
string | null
event_types
string[]
signing_secret
string | null

HMAC secret for verifying delivery signatures. Returned at creation and on a same-key retry within 30 days while current; store it securely

created_at
string<date-time> | null
updated_at
string<date-time> | null