Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Overview

The node enables server-side operations for Stream Chat, a chat messaging platform. Specifically, the Message - Send operation allows sending a message to a specified chat channel on behalf of a user. This is useful in scenarios such as:

  • Automating chat notifications or alerts into specific channels.
  • Sending messages programmatically from backend workflows.
  • Integrating chat messaging with other systems (e.g., CRM, monitoring tools).

For example, you can send a welcome message to a "general" channel when a new user joins your app, or post status updates automatically to a team channel.

Properties

Name Meaning
Message Text The content of the message to send. Supports plain text and markdown formatting.
Channel CID The identifier of the target channel in the format type:id (e.g., messaging:general).
User ID (Sender) The ID of the user who sends the message. This user must exist in your Stream Chat application.

Output

The output JSON contains the response from the Stream Chat API after sending the message. It typically includes details about the sent message such as its unique ID, timestamps, user info, and message content.

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 are needed for the API key to send messages on behalf of users.

Troubleshooting

  • Common issues:

    • Invalid or missing Channel CID: Ensure the channel exists and the format is correct (type:id).
    • Invalid User ID (Sender): The sender user must be registered in the Stream Chat app.
    • Insufficient API permissions: The API key must have rights to send messages.
  • Error messages:

    • "Unsupported operation: message.sendMessage": Indicates a misconfiguration or unsupported operation selected.
    • API errors related to authentication or authorization usually mean invalid credentials or insufficient permissions.
  • Resolution tips:

    • Verify channel and user IDs are correct and exist.
    • Check that the API key credential is valid and has required scopes.
    • Review Stream Chat service logs or dashboard for more detailed error info.

Links and References

Discussion