Sign in
latestOpenAPI 3.0.22026-08-1451965.7 KB

f5a72ed18934

Webhooks

Create Webhook

Register a webhook endpoint. Response includes the signing secret EXACTLY ONCE -- store it on the customer side before closing the response. We persist only its peppered hash.

400 on:

  • unknown event type
  • duplicate (customer_id, url) -- they already have one for that URL; DELETE the old one first or just keep using it
post/v1/webhooks

Headers

X-Api-Keystring

Request body

urlstring uri required
eventsstring[]
labelstring

Response

Successful Response

{"stackTrail":"paths:/v1/webhooks:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown"}