Configure project webhook

POST

Create or replace the project webhook for the project behind the API key, and activate it. The response carries the signing secret; an existing secret is kept.

This is where invitation.status_changed is delivered. Events are scoped to this project: when you onboard clients in sub-accounts, call this with each sub-account's API key.

Authorization

Authorizationheaderrequired
Bearer YOUR_API_KEY. Create a key in the dashboard.

Body

application/json

urlstring<uri>required
eventsstring[]required
One ofinvitation.status_changedbroadcast.status_changeddomain.verifieddomain.failed
Limitsmin items 1

Responses

201Webhook configured.

webhookobjectrequired
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.
4 properties
- urlstring<uri>required
- eventsstring[]required
  One ofinvitation.status_changedbroadcast.status_changeddomain.verifieddomain.failed
- secretstring
  Signing secret for X-Zavu-Signature. Returned only by POST /v1/invitations/webhook.
- activebooleanrequired

400Invalid URL or an event a project webhook cannot subscribe to.

codestringrequired
messagestringrequired
detailsobject

401Unauthorized.

codestringrequired
messagestringrequired
detailsobject


curl -X POST "https://api.zavu.dev/v1/invitations/webhook" \
  -H "Authorization: Bearer $ZAVUDEV_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://your-app.com/webhooks/zavu",
  "events": [
    "invitation.status_changed"
  ]
}'


{
  "webhook": {
    "url": "https://your-app.com/webhooks/zavu",
    "events": [
      "invitation.status_changed"
    ],
    "secret": "whsec_abc123...",
    "active": true
  }
}