Outbound webhooks overview

Outbound webhook integrations enable you to trigger serverless functions and notify HTTP endpoints when events occur in Ably.

Events include when messages are published, when presence events occur, changes in channel occupancy and when channels are created or discarded. Data can be delivered individually or in batches to external services.

There are two ways to create an outbound webhook integration:

• Using the Ably dashboard.
• Using the Control API.

Set a filter to restrict which channels an integration applies to using a regular expression.

The following examples demonstrate channel names that you can match against using regular expressions to control which channels a webhook rule applies to:

mychannel:public
public
public:events
public:events:conferences
public:news:americas
public:news:europe

Copy
Copied!

• ^public.* — Matches any channel that starts with public. This includes public, both public:events channels, and both public:news channels.
• ^public$ — Matches only channels named exactly public.
• :public$ — Matches channels that end with :public. This includes only mychannel:public.
• ^public:events$ — Matches channels named exactly public:events. This does not include public:events:conferences.
• ^public.*europe$ — Matches channels that start with public and end with europe. This includes only public:news:europe.
• news — Matches any channel name that includes the word news. This includes public:news:americas and public:news:europe.

You can configure webhooks to listen for the following event types:

In single request mode, a POST request is made to your endpoint each time an event occurs.

This is useful in certain use cases where an endpoint can only process one message per request, however it can lead to the endpoint being overloaded in high-throughput scenarios. Single requests are best suited to where this a 1:1 relationship between messages being sent and the events being called.

Multiple requests can be in-flight at once, however be aware there is a limit on concurrency. If it is exceeded then new messages are placed in a short 10 message queue. If that is exceeded then further messages are rejected.

Ably will retry failed 5XX requests. If the response times out, Ably will retry twice, first after 4 seconds and then again after 20 seconds.

Batched requests are useful for endpoints that have the potential to be overloaded by requests, or have no requirement to process messages one-by-one.

Batched requests are published at most once per second, but this may vary by integration. Once a batched request is triggered, all other events will be queued so that they can be delivered in a batch in the next request. The next request will be issued within one second with the following caveats:

• Only a limited number of HTTP requests are in-flight at one time for each configured integration. Therefore, if you want to be notified quickly, you should accept requests quickly and defer any work to be done asynchronously.
• If there are more than 1,000 events queued for a payload, the oldest 1,000 events will be bundled into this payload and the remaining events will be delivered in the subsequent payload. Therefore, if your sustained rate of events is expected to be more than 1,000 per second or your servers are slow to respond, then it is possible a backlog will build up and you will not receive all events.

If a batched request fails, Ably will retry the request using an exponential backoff strategy.

The backoff delay follows the formula: delay = delay * sqrt(2) where the initial delay is 1 second. For example, if a webhook request fails repeatedly, the retry delays will be:

• Initial request := 1.4s wait → 1st retry.
• 1st retry := 2s wait → 2nd retry.
• 2nd retry := 2.8s wait → 3rd retry.
• 3rd retry := 4s wait → 4th retry.
• 4th retry := 5.6s wait → successful request.

The back off for consecutively failing requests will increase until it reaches 60s. All subsequent retries for failed requests will then be made at 60s intervals until a request is successful. The queue of events is retain for 5 minutes. If an event cannot be delivered within that time then events are discarded to prevent the queue from growing indefinitely.

Given the various potential combinations of enveloped, batched, and message sources, it’s helpful to understand what to expect in different scenarios.

Batched events will have the following headers:

Each batched message will have the following fields::

For message events, the data field will contain the following:

The following example is a batched message payload:

{
  "items": [{
    "webhookId": "ABcDEf",
    "source": "channel.message",
    "serial": "a7bcdEFghIjklm123456789:4",
    "timestamp": 1562124922426,
    "name": "channel.message",
    "data": {
      "channelId": "chat-channel-4",
      "site": "eu-west-1-A",
      "messages": [{
        "id": "ABcDefgHIj:1:0",
        "clientId": "user-3",
        "connectionId": "ABcDefgHIj",
        "timestamp": 1123145678900,
        "data": "the message data",
        "name": "a message name"
      }]
    }
  }]
}

Copy
Copied!

The Ably SDK automatically decodes messages sent over the Realtime service into messageobjects. However, batched, enveloped webhook payloads require explicit decoding using:

Message.fromEncoded

For an array of messages.

Message

For a single message.

The benefits of decoding include fully restoring data to its original datatype using encoding. Additionally, it supports automatic decryption when an encryption key is provided. Its recommended to decode all messages received via webhooks to ensure proper data handling.

The following example demonstrates how to decode an array of messages received via a webhook:

JavaScript
JavaScript v2.11

webhookMessage.items.forEach((item) => {
  const messages = Ably.Realtime.Message.fromEncodedArray(item.data.messages);
  messages.forEach((message) => {
    console.log(message.toString());
  })
})

Copy
Copied!

Batched presence events group multiple presence messages in a single payload. presence events data contains:

data.channelId

The name of the channel the presence event belongs to.

data.site

An internal site identifier, indicating the primary datacenter the member is present in.

data.presence

An Array of raw presence messages.

The following is an example of a batched presence payload:

{
  "items": [{
    "webhookId": "ABcDEf",
    "source": "channel.presence",
    "serial": "a7bcdEFghIjklm123456789:4",
    "timestamp": 1562124922426,
    "name": "presence.message",
    "data": {
      "channelId": "education-channel",
      "site": "eu-west-1-A",
      "presence": [{
        "id": "ABcDefgHIj:1:0",
        "clientId": "bob",
        "connectionId": "ABcDefgHIj",
        "timestamp": 1123145678900,
        "data": "the message data",
        "action": 4
      }]
    }
  }]
}

Copy
Copied!

Presence messages sent over the realtime service are automatically decoded into PresenceMessage objects by the Ably client library. For webhooks, you need to do this manually using PresenceMessage.fromEncodedArray on the data.presence array, or PresenceMessage.fromEncoded on an individual entry. These methods convert the encoded values into PresenceMessage objects—either as an array or a single instance.

This allows you to decode the numerical action into a Presence action string (such as enter update or leave, fully decode the data (using the encoding) back into its original datatype or an equivalent in the client library, and, if you’re using encryption, pass your encryption key to decrypt the data.

The following example demonstrates how to decode an array of presence messages received via a webhook:

JavaScript
JavaScript v2.11

webhookMessage.items.forEach((item) => {
  const messages = Ably.Realtime.PresenceMessage.fromEncodedArray(item.data.messages);
  messages.forEach((message) => {
    console.log(message.toString());
  })
})

Copy
Copied!

Ably includes the following fields in the data object for batched channel.lifecycle events:

data.channelId

The name of the channel where the lifecycle event occurred.

data.status

a A ChannelStatus object that describes the channel’s current state.

The name of a channel.lifecycle event will be channel.opened or channel.closed.

The following is example a batched channel lifecycle payload:

{
  "items": [{
    "webhookId": "ABcDEf",
    "source": "channel.lifecycle",
    "timestamp": 1562124922426,
    "serial": "a7bcdEFghIjklm123456789:4",
    "name": "channel.opened",
    "data": {
      "channelId": "chat-channel-5",
      "name": "chat-channel-5",
      "status": {
        "isActive": true,
        "occupancy": {
          "metrics": {
            "connections": 1,
            "publishers": 1,
            "subscribers": 1,
            "presenceConnections": 1,
            "presenceMembers": 0,
            "presenceSubscribers": 1,
            "objectPublishers": 1,
            "objectSubscribers": 1
          }
        }
      }
    }
  }]
}

Copy
Copied!

Enveloping events adds structured metadata such as the publisher’s clientId and the originating channel name, alongside the payload.

This metadata is useful when processing events dynamically or when additional context about the source is required. Enveloped messages are recommended for most use cases, as they provide a consistent format for all events.

Enveloped events include the following headers:

Each enveloped message contains the following fields:

In addition, it will contain another field which will contain the actual message, which is named according to the message type.

For message events, the messages array contains a raw message.

The following is an example of an enveloped message payload:

{
  "source": "channel.message",
  "appId": "aBCdEf",
  "channel": "channel-name",
  "site": "eu-central-1-A",
  "ruleId": "1-a2Bc",
  "messages": [{
    "id": "ABcDefgHIj:1:0",
    "connectionId": "ABcDefgHIj",
    "timestamp": 1123145678900,
    "data": "some message data",
    "name": "my message name"
  }]
}

Copy
Copied!

Ably SDKs automatically decode messages into Message objects. Messages sent via an integration need to be decoded manually.

There are two methods available for decoding messages into Message objects:

• Message.fromEncodedArray() for an array of messages.
• Message.fromEncoded() for single messages.

There are also equivalent methods for decoding presence messages into PresenceMessage objects:

• PresenceMessage.fromEncodedArray() for an array of presence messages.
• PresenceMessage.fromEncoded() for single messages.

Decoding is essential because it reconstructs the original data payload using the encoding field, ensuring the correct data type is restored, whether it’s a string, binary, or structured object. If the message was encrypted, passing your encryption key to the method allows the SDK to decrypt data automatically.

Ably strongly recommends decoding all messages received over integrations before processing them to avoid issues with unexpected data formats.

The following example demonstrates how to decode an array of messages received via a webhook:

JavaScript
JavaScript v2.11

const messages = Ably.Realtime.Message.fromEncodedArray(item.messages);


messages.forEach((message) => {
  console.log(message.toString());
});

Copy
Copied!

Webhook presence events contain raw presence data in the presence array.

The following example is an enveloped message payload with a presence array:

{
  "source": "channel.message",
  "appId": "aBCdEf",
  "channel": "channel-name",
  "site": "eu-central-1-A",
  "ruleId": "1-a2Bc",
  "presence": [{
    "id": "abCdEFgHIJ:1:0",
    "clientId": "bob",
    "connectionId": "Ab1CDE2FGh",
    "timestamp": 1582270137276,
    "data": "some data in the presence object",
    "action": 4
  }]
}

Copy
Copied!

Presence messages sent over Realtime are automatically decoded into PresenceMessage objects by the Ably SDK. However, webhook presence messages require explicit decoding.

To decode presence messages received via webhooks, use the appropriate method:

• For multiple messages, use PresenceMessage.fromEncodedArray() on the presence array.
• For a single message, use PresenceMessage.fromEncoded() on an individual presence entry.

Both methods convert encoded presence messages into PresenceMessage objects, restoring the original format.

Decoding presence messages provides several advantages:

• It converts numerical presence action values into readable strings such as enter, update, or leave.
• It reconstructs the original data field, ensuring it matches the format it was sent in.
• If encryption is enabled, passing your encryption key will automatically decrypt the data field.

Ably strongly recommends decoding all presence messages received via webhooks to ensure proper data handling.

The following example demonstrates decoding an array of presence messages using the Ably JavaScript SDK:

JavaScript
JavaScript v2.11

const messages = Ably.Realtime.PresenceMessage.fromEncodedArray(item.messages);
messages.forEach((message) => {
  console.log(message.toString());
})

Copy
Copied!

You can turn off enveloping if your endpoint only needs the raw message payload or follows a strict data structure. This results in smaller payloads and eliminates the need to parse additional metadata. However, it requires you to handle raw payload decoding manually.

Non-enveloped webhook messages include headers that provide essential context about the payload, such as its source, format, and metadata. The following headers are included in all non-enveloped messages:

For message events, there will be additional headers:

The payload will contain the data of the message.

For example, if you publish a message to the channel my_channel using the following cURL request:

curl -X POST https://rest.ably.io/channels/my_channel/messages \
          -u "<loading API key, please wait>" \
          -H "Content-Type: application/json" \
          --data '{ "name": "publish", "data": "example" }'

API Key:
Demo Only
Copy
Copied!

The x-ably-message-name header would be publish and the payload would be example.

For Presence events, there will be the additional headers:

The payload will contain the data of the Presence message.

The following example demonstrates a non-enveloped enter presence event:

JavaScript
JavaScript v2.11

realtime = new Ably.Realtime({
  key: '<loading API key, please wait>',
  clientId: 'bob'
});
channel = realtime.channels.get('some_channel');
await channel.presence.enter('some data');

API Key:
Demo Only
Copy
Copied!

The x-ably-message-action header would be enter and the payload would be some data.

Ably advises you to use a secure HTTPS URL when you configure webhooks. This way, you ensure that all communication with your servers is encrypted with TLS and cannot be intercepted.

In addition, Ably optionally supports signing webhook requests so you can verify their authenticity. This applies to both single and batched webhook requests, as well as any streaming integrations that also rely on HTTP-based callbacks. Ably sends the signature in the X-Ably-Signature header for batched requests and references the connected key in the X-Ably-Key header.

The following steps are required to verify the signature:

1. Start with the webhook request body. This is a JSON string encoded with content-encoding utf-8.
2. Identify the key based on the keyId indicated in the X-Ably-Key header.
3. Calculate the HMAC of that request body using the SHA-256 algorithm and the corresponding keyValue (the secret part of the key after the :.
4. Encode the resulting HMAC using RFC 3548 base64.
5. Compare that result with the signature value in the X-Ably-Signature header.

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

1. Set up a free RequestBin HTTP endpoint test URL.
2. Configure a webhook with the URL set to the RequestBin endpoint. Make sure you choose to batched messages and use a key to sign each webhook request.
3. Trigger an event using the Dev Console in your app dashboard. This will generate a webhook. Then confirm that RequestBin received the webhook.