Webhook API documentation + announcement blog + changelog#2875
Webhook API documentation + announcement blog + changelog#2875atharvadeosthale wants to merge 4 commits intomainfrom
Conversation
Greptile SummaryThis PR adds programmatic webhook management via Server SDKs, backed by new
Confidence Score: 4/5Safe to merge after the Swift verification snippet is corrected; the timing vulnerability would be copied verbatim by Swift developers. One P1 security finding remains — the Swift src/routes/docs/advanced/platform/webhooks/+page.markdoc (Swift verification snippet lines 938–941; Java create snippet lines 206–220)
|
| Filename | Overview |
|---|---|
| src/routes/docs/advanced/platform/webhooks/+page.markdoc | Major expansion with SDK examples for create/update/delete, and updated verification snippets — Swift verification uses elementsEqual which short-circuits and is not constant-time; Java create has an extra enabled param not present in the Kotlin equivalent. |
| src/routes/blog/post/announcing-webhooks-api/+page.markdoc | New announcement blog post for the Webhooks API; content is clear and consistent with the docs page examples. |
| src/routes/changelog/(entries)/2026-04-10.markdoc | New changelog entry describing the Webhooks API launch; concise and correct. |
| src/routes/docs/advanced/platform/api-keys/+page.markdoc | Adds webhooks.read and webhooks.write rows to the scopes table; straightforward and correct. |
Reviews (4): Last reviewed commit: "using import for server node" | Re-trigger Greptile
| ## Create a webhook | ||
|
|
||
| ```server-nodejs | ||
| const sdk = require('node-appwrite'); |
There was a problem hiding this comment.
Lets switch to modern import statement, import { Client, Webhooks } from 'node-appwrite';
| - **Migration and seeding scripts** that replicate webhook configurations across environments | ||
| - **Admin dashboards** that let non-technical team members manage webhooks without Console access | ||
|
|
||
| # How it works |
There was a problem hiding this comment.
Worth mentioning SDK version in which it was added
There was a problem hiding this comment.
Maybe command to upgrade too
There was a problem hiding this comment.
Maybe link to SDK changelogs as well
|
|
||
| Once your API key has the appropriate scopes, you can manage webhooks through any Appwrite Server SDK. | ||
|
|
||
| ## Create a webhook |
There was a problem hiding this comment.
Might be worth having some more examples:
- showcase of ability to set httpUser and httpPass
- showcase ability to list webhooks (filter, paginate, maybe)
- Ability to rotate signature key
| webhookId: '<WEBHOOK_ID>' | ||
| }); | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Might be worth mentioning all runtimes we have SDKs for, so they know they can use all of that
|
|
||
| This is especially valuable for: | ||
|
|
||
| - **CI/CD pipelines** that need to register webhooks as part of environment setup |
There was a problem hiding this comment.
Considering CI/CD use case, it might be smart to have some CLI examples too
PR changes webhooks pages, make it more informative, adds announcement blog, and changelog.