Version 0.5.3
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 |
| account.create | Triggers any time a new user register an account. |
| account.delete | Triggers any time a new user is deleting its account. |
| account.update.email | Triggers any time a a user updates his or her acoount email address. |
| account.update.name | Triggers any time a a user updates his or her acoount name. |
| account.update.password | Triggers any time a a user updates his or her acoount password. |
| account.update.prefs | Triggers any time a a user updates his or her acoount preferences. |
| account.sessions.create | Triggers any time a new user is creating a new login session. |
| account.sessions.delete | Triggers any time a new user is login out from a session. |
| database.documents.create | Triggers any time a new database document is being created. |
| database.documents.patch | Triggers any time a new database document is being updated. |
| database.documents.delete | Triggers any time a database document is being deleted. |
| storage.files.create | Triggers any time a storage file has been created. |
| storage.files.updated | Triggers any time a storage file has been updated. |
| storage.files.delete | Triggers any time a file 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-Webhook-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' |