Actions60
- User Actions
- Channel Actions
- Accept Invite
- Add Members
- Add Moderators
- Archive
- Ban User
- Create
- Delete
- Delete File
- Delete Image
- Demote Moderators
- Disable Slow Mode
- Enable Slow Mode
- Get Config
- Hide
- Invite Members
- Mark Read
- Mark Unread
- Mute
- Mute Status
- Pin
- Query Channels
- Query Members
- Reject Invite
- Remove Members
- Send Action
- Send File
- Send Image
- Show
- Stop Watching
- Truncate
- Unarchive
- Unban User
- Unmute
- Unpin
- Update
- Watch
- Message Actions
- Moderation Actions
Overview
The node performs server-side operations on Stream Chat channels, enabling management and interaction with chat channels in a Stream Chat application. It supports a wide range of channel-related actions such as showing hidden channels, adding or removing members, updating channel details, archiving/unarchiving, muting/unmuting, pinning/unpinning, sending files/images, banning/unbanning users, enabling/disabling slow mode, and more.
This node is beneficial for automating chat channel administration tasks, integrating chat management into workflows, and building custom chat moderation or user engagement tools. For example, it can be used to programmatically unhide a previously hidden channel for a user, add new members to a team channel, or retrieve the configuration of a broadcast channel.
Properties
| Name | Meaning |
|---|---|
| Channel Type | The type of the channel. 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 CID. Required for most channel operations. |
| User ID | User ID for server-side operations related to a specific user in the channel (e.g., for show, hide, archive). Optional depending on operation. |
Output
The output JSON contains the result of the executed channel operation. This typically includes the response data from the Stream Chat API relevant to the requested action, such as channel details, confirmation of an action performed, or query results.
If the operation involves retrieving or modifying channel data, the output will reflect the updated or fetched channel information. For actions like "show" (unhide a channel), the output confirms the success of the operation.
The node does not output binary data for the "Show" operation or other channel operations.
Dependencies
- Requires an API key credential for authenticating with the Stream Chat service.
- The node uses the Stream Chat server-side client library to perform operations.
- Proper permissions must be granted to the API credentials to execute channel management operations.
- No additional environment variables are explicitly required beyond the API authentication setup.
Troubleshooting
Common Issues:
- Invalid or missing Channel ID or Channel Type parameters can cause errors.
- Insufficient API permissions may lead to authorization failures.
- Providing malformed JSON in properties like
channelDataortruncateOptionswill cause parsing errors. - Operations on non-existent channels or users will return errors indicating resource not found.
Error Messages:
"Unsupported operation: channel.show": Indicates the operation is not recognized; verify the operation name.- Errors mentioning invalid parameters usually mean required fields like Channel ID or User ID are missing or incorrect.
- API errors returned by Stream Chat will include messages describing the issue, such as permission denied or resource not found.
Resolution Tips:
- Double-check that all required input properties are provided and correctly formatted.
- Ensure the API key credential has the necessary permissions for the intended operation.
- Validate JSON inputs using external tools before entering them.
- Use the node's "Continue On Fail" option to handle errors gracefully during bulk processing.