Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pokulabs.com/llms.txt

Use this file to discover all available pages before exploring further.

Use WebSockets when your agent wants to receive Poku events over an open connection instead of exposing an HTTP webhook endpoint. The WebSocket stream emits the same event types as webhooks. You can subscribe to message.received, form.received, and call.conversation.ended.

​
Connect

Connect to the Poku API WebSocket endpoint: 
wss://ws.pokulabs.com
Authenticate with your Poku API key using a bearer token: 
const ws = new WebSocket("ws://api.pokulabs.com", {
  headers: {
    Authorization: "Bearer <your-poku-api-key>",
  },
});
Some WebSocket clients, especially browser clients, cannot send custom headers. In those cases, pass the API key in the api_key query parameter: 
const ws = new WebSocket("wss://api.pokulabs.com?api_key=<your-poku-api-key>");
If authentication fails, Poku closes the connection with code 4001.

​
Subscribe to events

After connecting, send a subscribe message with the events you want to receive: 
{
  "type": "subscribe",
  "events": ["message.received", "form.received", "call.conversation.ended"]
}
Poku confirms the active subscriptions: 
{
  "type": "subscribed",
  "payload": {
    "events": ["message.received", "form.received", "call.conversation.ended"]
  }
}

​
Event format

WebSocket events use the same event names and payload shapes as webhooks. The only difference is the wrapper field: webhooks send eventType, while WebSockets send type. 
{
  "type": "message.received",
  "payload": {
    "interactionId": "ia_abc123",
    "medium": "sms",
    "from": "+14155550199",
    "to": "+14155550100",
    "body": "Hey, are you available tomorrow?",
    "mediaUrls": []
  }
}
See the Webhook page for the full event payload reference.