Skip to content

Create a webhook subscription

POST
/v1/webhooks

Register a new HTTPS endpoint to receive event notifications. The signing secret is returned exactly once in this response — store it immediately. Subsequent reads of the subscription do not surface the secret.

Authorizations

Parameters

Header Parameters

X-API-Key
Any of:
string

Request Body required

Body for POST /v1/webhooks.

object
description
Any of:
string
<= 255 characters
endpoint_url
required
string
>= 8 characters <= 2048 characters
event_types
required
Array<string>
>= 1 items

Responses

201

Successful Response

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string