TRaX Docs
guides

Reconnect one platform's chat

When one platform's chat stops arriving in the studio, you can reconnect that platform without touching the others.

Read the current state

GET /v1/studios/{studioId}/chat/connectors (scope chat:read) lists each linked platform's connector and its latest reconnect attempt in a data array. Reading changes nothing. Each connector looks like this:

{
  "platform": "kick",
  "desired": true,
  "requiresLiveBroadcast": false,
  "state": "connecting",
  "error": "",
  "reconnectAttemptId": "example-attempt",
  "reconnectState": "reconnecting",
  "reconnectError": "",
  "reconnectUpdatedAt": "2026-09-06T06:30:00.123456789Z"
}

requiresLiveBroadcast is true for platforms such as YouTube whose chat cannot attach until the broadcast is live, so "not connected" while off air is expected there. state describes whether chat is attached now; it does not promise that every future message will arrive.

Reconnect

Send POST /v1/studios/{studioId}/chat/connectors/kick/reconnect with no body, replacing kick with the platform key from the connector list. It requires scope studios:write and edit permission on the studio.

Only that platform is reconnected, and its messages may pause briefly.

Status Meaning
202 The reconnect has started. The body is the connector.
400 The platform key is not a lower-case platform name.
409 The platform is not linked or cannot be reconnected. The error message says why.
404 The studio does not exist or is not yours.
503 write_disabled Writes are paused on this deployment.

A reconnect cannot replace an OAuth consent step. If the account needs to be relinked, relink it.

Show the result

202 means the request was accepted, not that chat is back. Use reconnectState:

  • reconnecting: show progress.
  • succeeded: chat is attached again.
  • failed: show reconnectError and let the user retry.

Updates arrive as chatConnector events on the studio events stream, GET /v1/studios/{studioId}/events, and in the chatConnectors rows of its snapshot, with the same fields as above. Receiving them needs chat:read in addition to the stream's own scopes (stream:read, sources:read and destinations:read); without it, connector rows and events are left out and the rest of the stream continues. The stream carries connector state, not chat messages.

When you apply an update:

  • Match both platform and reconnectAttemptId. An update for Twitch does not finish a pending Kick reconnect.
  • Ignore an update whose reconnectUpdatedAt is older than the one you have. Compare the full timestamp, including the fractional seconds.
  • Replace the whole row, including empty error fields, which clear an earlier error.

Retries and missed events

Requests sent while a reconnect is running share that attempt. A request sent after it finishes starts a new one. So if a request times out, read GET /v1/studios/{studioId}/chat/connectors before you retry.

If the events stream drops, reconnect with Last-Event-ID. When the server can no longer replay from that id it sends a fresh snapshot, which includes the result of any attempt you missed.

See the API reference for the full request, response and error details.