Skip to main content
PATCH
Update project webhook

Authorizations

Authorization
string
header
required

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

Body

application/json

Only valid on a webhook created with POST /v1/invitations/webhook; updating one that does not exist returns 400.

url
string<uri>
events
enum<string>[]
Minimum array length: 1

Events a project webhook can subscribe to. Any other value is refused with 400.

Available options:
invitation.status_changed,
broadcast.status_changed,
domain.verified,
domain.failed
active
boolean

Response

Webhook updated. The secret is not returned.

webhook
object
required

The project-level webhook. It receives project events such as invitation.status_changed for this project only: a parent project does not receive its sub-accounts' events, so configure one per sub-account with that sub-account's API key.