Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Overview

The "Send File" operation in the Channel resource of this node allows users to upload and send a file to a specified chat channel within the Stream Chat platform. This is useful for sharing documents, images, or other file types directly in a chat conversation.

Common scenarios include:

  • Sharing reports, PDFs, or presentations in team channels.
  • Sending images or media files in messaging or livestream channels.
  • Automating file distribution in workflows that involve chat communication.

For example, a marketing team could automatically upload and share campaign assets in their group channel, or a customer support bot could send logs or screenshots to a private messaging channel.

Properties

Name Meaning
Channel Type The type of channel where the file will be sent. Common options: "messaging" (1-on-1 chats), "team" (group channels), "livestream" (broadcast channels).
Channel ID Unique identifier for the target channel (e.g., "general", "random", "team-alpha"). Combined with Channel Type to form the full channel identifier.
File Path Local file system path to the file that should be uploaded and sent to the channel.
File Name Optional name to assign to the uploaded file. If not provided, the original file name may be used.

Output

The output JSON contains the response from the Stream Chat API after uploading and sending the file. This typically includes metadata about the uploaded file such as its URL, size, MIME type, and associated message details in the channel.

If the node supports binary data output (not explicitly shown here), it would represent the uploaded file content or related binary information.

Dependencies

  • Requires an active connection to the Stream Chat service via an API key credential configured in n8n.
  • The node uses the Stream Chat server-side client SDK to perform operations.
  • The local environment must have access to the file specified by the "File Path" property for upload.

Troubleshooting

  • File Not Found: Ensure the "File Path" points to a valid and accessible file on the machine running n8n.
  • Invalid Channel ID or Type: Verify that the channel exists and the combination of Channel Type and Channel ID is correct.
  • Permission Errors: The API key used must have permissions to send files in the specified channel.
  • Network Issues: Check connectivity to the Stream Chat API endpoint.
  • Unsupported File Types or Size Limits: Confirm the file meets Stream Chat's allowed formats and size restrictions.

Common error messages:

  • "Unsupported operation: channel.sendFile": Indicates a misconfiguration or unsupported action; verify the operation and resource selections.
  • API errors with messages about authentication or authorization usually mean the API key lacks required scopes or is invalid.

Links and References

Discussion