GET
/data-streams/user/{streamSlug}/subscribeSubscribe to Stream
Opens a Server-Sent Events stream of a user stream's messages, starting after a sequence number and following new messages as they arrive.
The connection closes after about 25 seconds; reconnect with Last-Event-ID to continue where it stopped.
Needs PROJECT_ADMIN or PROJECT_AUDITOR.
Parameters
| streamSlug * | path | The stream's slug, unique in the project. |
| fromSequence | query | Start after the message with this sequence. The Omit it, or send 0, to start at the oldest retained message. |
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
Responses
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | A Server-Sent Events stream of the stream's messages. | |
| 403 | K9O_RBAC_DENY | Reading Pulse Streams requires PROJECT_ADMIN or PROJECT_AUDITOR. |
| 404 | K9O_STREAM_NOT_FOUND | No active Pulse Stream with that slug in this project. |
| 503 | K9O_STREAM_UNAVAILABLE | Pulse Stream messaging is not configured in this deployment, or the project's stream account is not provisioned, so no messages can be read. Retry later. |
Response body (200)
TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.streams.subscribe('<streamSlug>')Showing example in TypeScript
Response example (200)
"retry: 1000\n:ok\n\nid: 1201\ndata: {\"sequence\":\"1201\",\"subject\":\"k9o.us01.org_5t2q8m1x.proj_8x2k4m9q1z7w.user.pstr_01hx8k2m9q4w7z3n5r6t._\",\"data\":{\"orderId\":\"ord_1042\"},\"publishedAt\":\"2026-11-02T14:05:31.512Z\"}\n\n"