Agent inboxes

Stream events

WS/v1/agent/inbox/:id/stream

Opens a WebSocket that pushes events with the same envelope and lease rules as Pull. Send {type: "ack" | "release" | "extend", id, event_id, lease_id} frames to close leases. Up to 10 sockets per inbox.

Parameters

Path parameters1

idstringRequired

Destination ID (dst_…).

Query parameters3

max?integer

Events leased to the socket at once, 1 to 10. Default 1.

order?string

fifo, lifo or priority.

type?string

Only this event type.

Returns

200A JSON object describing the result.Errors return error and message; see Errors and limits.

WSStream events

# Connect with any WebSocket client
wscat -c "wss://api.getensue.com/v1/agent/inbox/dst_…/stream" \
  -H "authorization: Bearer $ENSUE_API_KEY"

const ws = new WebSocket("wss://api.getensue.com/v1/agent/inbox/dst_…/stream?access_token=" + process.env.ENSUE_API_KEY);
ws.onmessage = (m) => console.log(JSON.parse(m.data));

# pip install websockets
import asyncio, os, websockets

async def main():
    url = "wss://api.getensue.com/v1/agent/inbox/dst_…/stream"
    async with websockets.connect(url, additional_headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"}) as ws:
        print(await ws.recv())

asyncio.run(main())

200Response

Returns a JSON object describing the result.