AsyncAPI channel · Signal
· Signal Server Real-Time Events
/v1/websocket
The primary authenticated WebSocket channel for real-time message delivery, receipt confirmations, and typing indicators. Clients maintain a persistent connection on this channel to receive encrypted messages as they arrive. The server uses a request-response framing protocol over the WebSocket where both sides can initiate requests.
Provider:SignalAsyncAPI: v2.6.0Spec: Signal Server Real-Time EventsOperations: 2Messages: 6
Channel address
/v1/websocket
Operations
publish
receiveMessages
Receive real-time messages from the server
subscribe
sendWebSocketRequest
Send requests over the WebSocket channel
Messages
MessageEnvelope
An encrypted message envelope containing a Signal Protocol message.
Content-Type: application/json
ReceiptMessage
A receipt message confirming delivery or read status of a previously sent message.
Content-Type: application/json
TypingIndicator
A typing indicator showing that a contact is currently composing a message.
Content-Type: application/json
StorySendMessage
A message containing a story post sent by a contact.
Content-Type: application/json
WebSocketRequestMessage
A request message sent over the WebSocket connection using the Signal WebSocket framing protocol.
Content-Type: application/json
WebSocketResponseMessage
A response message sent over the WebSocket connection acknowledging a previous request.
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.