Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Overview

The node enables server-side operations on Stream Chat channels, specifically allowing you to watch a channel for real-time updates and changes. Watching a channel means subscribing to events such as new messages, member changes, or other channel activities, which is useful for building interactive chat applications that react instantly to channel state changes.

Common scenarios include:

  • Real-time monitoring of a messaging channel to update user interfaces immediately when new messages arrive.
  • Keeping track of membership changes in team or group channels.
  • Reacting to broadcast/live stream channel events dynamically.

For example, you might use this node to watch a "messaging" type channel with ID "general" so your app can display incoming messages without polling.

Properties

Name Meaning
Channel Type The type of the channel to watch. Common options: "messaging" (1-on-1 chats), "team" (group channels), "livestream" (broadcast channels).
Channel ID Unique identifier for the channel (e.g., "general", "random", "team-alpha"). Combined with type to form the full channel ID (CID).

Output

The output JSON contains the response from the Stream Chat API's watch method for the specified channel. This typically includes detailed information about the channel state, such as current members, messages, watchers, and any recent events or updates.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Stream Chat service.
  • The node uses the official Stream Chat server SDK client internally.
  • Proper permissions must be granted to the API key to allow watching channels.

Troubleshooting

  • Common issues:

    • Invalid or missing channel ID or type will cause errors.
    • Insufficient API permissions may result in authorization failures.
    • Network connectivity problems can prevent successful subscription.
  • Error messages:

    • "Unsupported operation: channel.watch" if the operation is not recognized (unlikely if configured correctly).
    • API errors indicating invalid channel or permission denied; verify channel existence and API key scopes.
  • Resolution tips:

    • Double-check the channel type and ID inputs.
    • Ensure the API key used has rights to read/watch the specified channel.
    • Confirm network access to Stream Chat servers.

Links and References

Discussion