Webhook API documentation + announcement blog + changelog#2875
Webhook API documentation + announcement blog + changelog#2875atharvadeosthale wants to merge 5 commits intomainfrom
Conversation
Greptile SummaryThis PR adds a Webhooks API announcement blog post, a changelog entry, and significantly expands the webhooks documentation to cover full programmatic management (create, list, get, update, delete, rotate signing key) across all 12 supported Server SDKs. The API keys scopes table is updated to include Confidence Score: 5/5Safe to merge; all findings are minor style/consistency issues that don't affect correctness or user experience. No P0 or P1 issues found. The two remaining comments are P2 — a redundant length check in the Swift verification snippet and an src/routes/docs/advanced/platform/webhooks/+page.markdoc — minor Swift snippet redundancy and Rust Important Files Changed
Reviews (5): Last reviewed commit: "address comments" | Re-trigger Greptile |
|
|
||
| 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
There was a problem hiding this comment.
It might be better to have a separate blog on this showcasing a real-world use-case
|
|
||
| {% multicode %} | ||
| ```server-nodejs | ||
| const result = await webhooks.updateSecret({ |
There was a problem hiding this comment.
You can now also pass secret parameter, if you want to use custom secret. Worth showcasing, its very good feature for when you need to do key rotation 0 downtime.
| tls: true | ||
| }); | ||
| ``` | ||
| ```server-php |
There was a problem hiding this comment.
Hmm so many examples might make article very very very long. I recall we have tab support, maybe we can use it here? Show only Node by default, but have tabs for different languages
|
|
||
| $webhooks = new Webhooks($client); | ||
|
|
||
| $result = $webhooks->create( |
There was a problem hiding this comment.
Important after creation to print secret, in our code samples. Because this is the only time you are now able to see secret.
if you get webhook, or list webhooks, you will no longer see secret (it will be emty)
| # Get started | ||
|
|
||
| The Webhooks API is available on **Appwrite Cloud** today. | ||
|
|
||
| 1. Navigate to **Overview** > **Integration** > **API keys** and create or update an API key with the `webhooks.read` and `webhooks.write` scopes. | ||
| 2. Initialize a Server SDK with your API key. | ||
| 3. Use the `Webhooks` service to manage your webhooks from code. |
There was a problem hiding this comment.
Not sure if this makes sense after the code examples
PR changes webhooks pages, make it more informative, adds announcement blog, and changelog.