trickroom / Docs
Sign in
API reference/assistants

Stream a subscription's events as they happen

SSE push for a pull subscription: event: events carries JSON {data: AssistantEvent[]} with the rows polling would return after the cursor, as soon as they exist. Its id is the last sequence. Acknowledge with the ack route as when polling; unacknowledged rows replay on reconnect. Keepalive comments arrive after idle reads (30 seconds). A stream-error event contains {code} and closes the stream.

GET/v1/applications/{id}/subscriptions/{subscriptionId}/events/stream

Authorization

Authorizationstringrequired

Bearer tak_… — an application API key. Keep it on your backend; all resources are scoped to that application.

Create an application key →

Path parameters

idstringrequired

Min length: 1

subscriptionIdstringrequired

Min length: 1

Query parameters

afterinteger

Last received application event sequence.

Default: 0 · Minimum: 0 · Maximum: 2147483647

Response

200Stream a subscription's events as they happen
X-Request-Idstring

Server-generated request identifier for logs and support.

text/event-stream

valuestring
4XX400 invalid input; 401 missing/revoked credentials; 403 disallowed operation/application; 404 missing or inaccessible resource; 409 conflicting submission/version/state; 413 body too large; 415 unsupported content type. Inspect error.code, not message text.
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired
Object fields
codestringrequired
messagestringrequired
request_idstringrequired

Additional keys: any

5XX500 unexpected failure or 503 unavailable dependency. A failed response does not prove that a submission was not committed. Retry job/flow admission with the same key and body.
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired
Object fields
codestringrequired
messagestringrequired
request_idstringrequired

Additional keys: any