Generic channel event delivered by the server to subscribers. Carries
the application-defined `event` name, the `channel` it was triggered
on, a JSON-encoded `data` payload, and, when the publish was made via
a signed-in user, an optional `user_id`. Encrypted channels deliver
the same envelope, but `data` contains `ciphertext` and `nonce`
fields produced by libsodium secretbox.
Server-delivered application event on a public, private, presence, or cache channel.
Content-Type: application/json
EncryptedChannelEvent
Server-delivered event on a `private-encrypted-*` channel; payload is libsodium secretbox-encrypted.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.