Skip to main content
GET
Read the webhook

Authorizations

Authorization
string
header
required

The agency's secret key, sent as Authorization: Bearer <key>. One key per agency.

Response

The registration, without the secret.

The agency's webhook registration.

url
string
required

Where we send events.

events
string[]
required

The event types we send.

status
enum<string>
required

active: we deliver to it. disabled: switched off after a 410 or 5 days of failures; register again to switch it back on.

Available options:
active,
disabled
disabled_reason
string | null

Why it was switched off.

secret
string | null

Returned only when we generated or changed it. Store it.