Docs

Webhooks

Webhooks allow you to build or set up integrations which subscribe to certain events on Appwrite. When one of those events is triggered, we'll send an HTTP POST payload to the webhook's configured URL. Webhooks can be used to purge cache from CDN, calculate data or send a Slack notification. You're only limited by your imagination.

Events

A list of all currently available events you can hook to:

Name Description
* Wildcard event. Trigger your URL on any event
database.documents.create Any time a new database document is being created
database.documents.patch Any time a new database document is being updated
database.documents.delete Any time a database document is being deleted
storage.upload Any time a file has been uploaded
storage.update Any time a file has been updated
storage.delete Any time a file has been deleted
webhook.create Any time a webhook has been created
webhook.update Any time a webhook has been updated
webhook.delete Any time a webhook has been deleted

Payload

Each event type has a specific payload format with the relevant event information. All event payloads mirror the payloads for the API payload which parallel to the event types.

Headers

HTTP requests made to your webhook's configured URL endpoint will contain several special headers:

Header Description
X-Appwrite-Event Name of the event that triggered this delivery.
X-Appwrite-Webhook-Name Name of the webhook as specified in your app settings
User-Agent Each request made by Appwrite will be 'Appwrite-Server'