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 programmatically. It supports a wide range of channel-related actions such as creating, updating, archiving, unarchiving, adding/removing members or moderators, muting/unmuting, pinning/unpinning, sending files/images, banning/unbanning users, enabling/disabling slow mode, and more.
This node is beneficial in scenarios where automated control over chat channels is needed, for example:
- Automatically unarchiving a channel when activity resumes.
- Managing membership and moderation in team or community chat channels.
- Sending files or images to channels as part of workflows.
- Enforcing moderation policies by banning or muting users.
- Integrating chat channel management into broader business processes or customer support systems.
Practical example: A customer support system could use this node to unarchive a previously archived support channel when a new ticket is created, ensuring the conversation can continue seamlessly.
Properties
| Name | Meaning |
|---|---|
| Channel Type | The type of 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. |
| User ID | User ID for server-side operations related to the channel (required for some operations like unarchive). |
Output
The output is a JSON object representing the result of the performed operation on the channel. This typically includes details about the channel state after the operation, such as confirmation of unarchiving or updated channel metadata.
If an error occurs during execution, the output JSON will contain an error field with the error message.
No binary data output is produced by this operation.
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 allow channel unarchiving and related actions.
Troubleshooting
Common issues:
- Invalid or missing Channel ID or Channel Type parameters.
- Insufficient permissions on the API key to perform unarchive operations.
- Attempting to unarchive a channel that is not archived or does not exist.
Error messages:
"Unsupported operation: channel.unarchive": Indicates the operation is not recognized; verify the Resource and Operation selections.- Errors containing
"Error in channel.unarchive operation": Usually due to invalid parameters or permission issues; check input values and API key scopes.
Resolution tips:
- Ensure the Channel ID and Channel Type are correctly specified.
- Verify the API key has the necessary permissions for channel management.
- Confirm the channel exists and is currently archived before attempting to unarchive.