-
Couldn't load subscription status.
- Fork 45
EDU-2092: Adds Generic HTTP webhooks page #2847
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.
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
Merged
franrob-projects
merged 3 commits into
main
from
EDU-2092-create-a-page-for-generic-outbound-webhooks
Oct 21, 2025
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| title: Generic HTTP webhooks | ||
| meta_description: "Configure generic HTTP webhooks to trigger HTTP endpoints and notify external services when events occur in Ably." | ||
| meta_keywords: "ably webhooks, http webhooks, webhook integration, generic webhooks, webhook endpoints, event notifications, realtime webhooks" | ||
| redirect_from: | ||
| --- | ||
|
|
||
| Generic HTTP webhooks enable you to trigger HTTP endpoints and notify external services when events occur in Ably. Events include when messages are published, presence events occur, changes in channel occupancy, and when channels are created or discarded. Data can be delivered individually or in batches to any HTTP endpoint. | ||
|
|
||
| ## Create a generic HTTP webhook integration | ||
|
|
||
| To create a generic HTTP webhook integration in your [dashboard](https://ably.com/dashboard/any): | ||
|
|
||
| 1. Login and select the application you wish to integrate with an HTTP endpoint. | ||
| 2. Click the **Integrations** tab. | ||
| 3. Click the **New Integration Rule** button. | ||
| 4. Choose **Webhook**. | ||
| 4. Choose **Webhook** (again). | ||
| 6. Configure the webhook [settings](#settings). | ||
| 7. Click **Create**. | ||
|
|
||
| You can also create a generic HTTP webhook integration using the [Control API](/docs/platform/account/control-api). | ||
|
|
||
| ## Settings | ||
|
|
||
| The following settings are available when creating a generic HTTP webhook integration: | ||
|
|
||
| | Setting | Description | | ||
| |---------|-------------| | ||
| | URL | The HTTP/HTTPS endpoint URL where webhook requests will be sent. Ably strongly recommends using HTTPS for security. | | ||
| | Headers | Optional HTTP headers to include with each request. Use the format `key:value`, for example, `X-Custom-Header:my-value`. Each header should be on a new line. | | ||
| | Request Mode | Choose between **Single request** (sends each event individually) or **Batch request** (groups multiple events into a single request). | | ||
| | Event types | Choose which event types trigger the webhook: `channel.message`, `channel.presence`, `channel.lifecycle`, or `channel.occupancy`. | | ||
| | [Channel filter](/docs/platform/integrations/webhooks#filter) | Filters the source channels based on a regular expression. | | ||
| | Encoding | Specifies the encoding format of messages. Either JSON or MsgPack. | | ||
| | Sign with key | Choose whether to sign webhook requests with your API key for security. | | ||
| | [Enveloped](/docs/platform/integrations/webhooks#enveloped) | When enabled (default), messages are wrapped in additional metadata. When disabled, only the raw message data is sent. | | ||
franrob-projects marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think you meant to delete step 5 - it was just the name that was wrong
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahhhh ok :)