Skip to content

Update project webhook

View .md
PATCH

Change the URL, the events, or whether the webhook is active. The webhook must already exist.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Body

application/json

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

Responses

200Webhook updated. The secret is not returned.
  • 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
400No project webhook is configured, or an invalid event was sent.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject