Skip to content

Docs: Improve and expand on webhook signature testing #2936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: Improve and expand on webhook signature testing #2936

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/pages/docs/platform/integrations/webhooks/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,8 @@ The following steps are required to verify the signature:

If you choose to sign your webhook requests, it is recommended that you try the following:

1. Set up a free [`RequestBin`](https://requestbin.com/) HTTP endpoint test URL.
2. [Configure](#configure) a webhook with the URL set to the `RequestBin` endpoint. Make sure you choose to [batched](#batched) messages and use a key to sign each webhook request.
3. Trigger an event using the Dev Console in your app [dashboard](https://ably.com/dashboard/any). This will generate a webhook. Then confirm that RequestBin received the webhook.
1. Set up your webhook testing/inspection tools:
- **Local testing/inspection**: Perform local tunneling with [ngrok](https://ngrok.com/download/linux), paired with [webhook-tester](https://github.com/tarampampam/webhook-tester). You can install webhook-tester [here](https://github.com/tarampampam/webhook-tester?tab=readme-ov-file#-installation). The ngrok CLI tool will generate your **webhook listener URL**.
- **Using zero-setup, cloud-based, webhook testing services**: Services like Beeceptor (https://beeceptor.com/webhook-integration/) or Webhook.site (https://webhook.site/) offer a zero-setup, no-login, free webhook testing endpoint for webhook monitoring, payload inspection and signature verification. These services provide you a unique, random endpoint URL, which is your **webhook listener URL**.
2. [Configure](#configure) your webhook sender (Ably) with the webhook listener URL obtained from **Step 1**. Make sure you choose to [batch](#batched) messages and use a key to sign each webhook request.
3. Trigger an event using the Dev Console in your app [dashboard](https://ably.com/dashboard/any). This will send a webhook event to your webhook testing/inspection tool via the webhook listener URL. You can, using your preferred choice of webhook testing/inspection tool, monitor requests and confirm that a webhook request was sent, and inspect request headers for signature verification.