Skip to main content
POST
Add a webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required

Your HTTPS endpoint. It must answer 2xx within 10 seconds; redirects are not followed.

Maximum string length: 2000
filters
object

Any filters of GET /v1/changes; none sends every change

Response

The webhook, with its signing secret (shown only now)

id
string
required
url
string
required
filters
object
required
failures
integer
required

Failed sends in a row

lastError
string | null
required
disabledAt
string<date-time> | null
required

Turned off after 8 failed sends in a row

createdAt
string<date-time>
required
secret
string
required