Skip to content
For LLMsView as Markdown·

Stream Chat

undefined

DetailValue
CategoryCommunication
Base URLhttps://chat.stream-io-api.com
AuthenticationAPI Key (Query)
Endpoints6
Connector keystream-chat

Using Stream Chat in a workflow

  1. Go to Connections and click New Connection.
  2. Pick Stream Chat from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown — the full list is below.

Available endpoints

EndpointSummary
GET Query Channels
GET Send Message
GET Query Users
GET Update Users
GET Send Reaction
GET Delete Channel

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET

Query Channels

DetailValue
Operation IDquery_channels_0
MethodGET
Path``

Parameters

No parameters.

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Stream Chat connection from the Connection dropdown.
  3. In the Operation dropdown, select query_channels_0.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Stream Chat API reference.

GET

Send Message

DetailValue
Operation IDsend_message_1
MethodGET
Path``

Parameters

No parameters.

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Stream Chat connection from the Connection dropdown.
  3. In the Operation dropdown, select send_message_1.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Stream Chat API reference.

GET

Query Users

DetailValue
Operation IDquery_users_2
MethodGET
Path``

Parameters

No parameters.

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Stream Chat connection from the Connection dropdown.
  3. In the Operation dropdown, select query_users_2.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Stream Chat API reference.

GET

Update Users

DetailValue
Operation IDupdate_users_3
MethodGET
Path``

Parameters

No parameters.

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Stream Chat connection from the Connection dropdown.
  3. In the Operation dropdown, select update_users_3.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Stream Chat API reference.

GET

Send Reaction

DetailValue
Operation IDsend_reaction_4
MethodGET
Path``

Parameters

No parameters.

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Stream Chat connection from the Connection dropdown.
  3. In the Operation dropdown, select send_reaction_4.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Stream Chat API reference.

GET

Delete Channel

DetailValue
Operation IDdelete_channel_5
MethodGET
Path``

Parameters

No parameters.

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Stream Chat connection from the Connection dropdown.
  3. In the Operation dropdown, select delete_channel_5.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Stream Chat API reference.