Register an endpoint
Needs thewebhooks:manage scope. You can also register endpoints in Settings → Webhooks.
Response
Where to send events. It must:
- use
https:// - resolve to a public address. Private, loopback, link-local, carrier-grade NAT, multicast and IPv6 ranges that embed an IPv4 address (NAT64, 6to4, Teredo) are refused.
- not contain a username or password
422. The address is checked again at every delivery.The events to receive. Leave it out to receive every event, including ones added later.
GET /webhook-endpoints. To remove one, call DELETE /webhook-endpoints/{id}. You can’t edit an endpoint, so delete it and create a new one.
Events
Payload
idis the event id. It’s the same for every endpoint that receives the event.data.objectis the invoice as it was when the event happened, in the same shape asGET /invoices. It has nolines. CallGET /invoices/{id}for those.
webhook-id, webhook-timestamp and webhook-signature headers. Verify them before you trust the payload.