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

Request

Headers

X-Api-Keystring

Request body

urlstring uri required
eventsstring[]
labelstring

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 3 revisions of this API.