Per-conversation channel. After `phx_join`, clients send new messages
with the `shout` event and read receipts with `messages:seen`, and
receive the same events broadcast from other participants (agent or
customer).
Send a message (and read receipts) into the conversation.
subscribe
receiveConversationEvents
Receive broadcast messages and acknowledgements.
Messages
shout
A new chat message broadcast to a conversation channel.
Content-Type: application/json
messages:seen
Marks agent messages in the conversation as seen.
Content-Type: application/json
phx_join
Phoenix channel join request.
Content-Type: application/json
phx_reply
Phoenix acknowledgement reply (status ok/error).
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.
Discovery needs no key. Ratings and market analysis are Pro.
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.