In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
...
- Archive channel
- Create channel
- Invite user
- List members
- Remove user
- Rename channel
- Retrieve channel info
- Unarchive channel
Prerequisites
A valid and active account in the Slack workspace.
...
Add valid Slack Scopes based on the intended operation. See Required Slack Scopes below for details.
Required Slack Scopes
Any action you want to perform within a Slack workspace , additionally needs appropriate Scopes assigned to your app. See the Scope and Permissions article in Slack API documentation for the complete list and each Account page under Configuring Slack Accounts for information on defining Scopes for your app.
| To | Bot Token Accounts | User Token Accounts ( user_scope) | Archive channel|
|---|---|---|---|
| channels:manage |
| |
| channels:read | channels:read | |
| N/A | |
Support for Ultra Pipelines
...
| Parameter Name | Data Type | Description | Default Value | Example | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Label | String |
| Channel Operations | Channel Operations | ||||||||
| Operation | Drop-down list | Select an operation from the following list of permitted channel operations and specify the corresponding details needed:
| List Members | Invite User | ||||||||
| Channel | String/Expression/Suggestion | Required for all channel operations except Create Channel. Click the
| N/A | #testprivate:G019B3ETYMB | ||||||||
| Users | String/Expression/Suggestion | Required for channel operation - Invite User. Click the suggested list of users available in the workspace. Alternatively, you can enter one or
more user IDs separated by commas. The user IDs are in the 11-character alphanumeric format. The specified users are invited to join the selected channel when you run the pipeline. | N/A | @user.name:W01A94P7MK1 W01A94P7MK1, W01A94P7MK2, W01A94P7MK3 | ||||||||
| User | String/Expression/Suggestion | Required for channel operation - Remove User. Click the suggested list of users available in the workspace. Alternatively, you can enter @user.name:<11-character alphanumeric user ID>@user.name@<11-character alphanumeric user ID>the user ID in the 11-character alphanumeric format. The specified user is removed from the selected channel when you run the pipeline. | N/A | W01A94P7MK1 | ||||||||
| Name | String/Expression | Required for channel operation - Create Channel. Enter a name for the new channel. | N/A | Support_Vertical | ||||||||
| Private | Check box | Required for channel operation - Create Channel. Select this check box to keep the new channel private – visible to only members/invitees. | Not selected | Selected | ||||||||
| New Name | String/Expression/Suggestion | Required for channel operation - Rename Channel. Enter the new name for the channel. | N/A | ReleaseTeam_Channel | ||||||||
| Snap Execution | Drop-down list | Select one of the three following modes in which the Snap executes:
| Execute only | Validate & Execute |
...
| Error | Reason | Resolution |
|---|---|---|
| Unable to rename the given channel. Reason: invalid_name_specials | You have provided an invalid name for renaming the channel. | Ensure that the name provided for the channel is valid (does not contain invalid special characters). |
| Unable to kick user from channel. Reason: Channel_not_found | You have specified an invalid channel to remove the user. | Ensure that the channel’s name is valid and that the user to be removed currently exists in is a member of the channel members list. |
| Unable to archive channel. Reason: Channel_not_found | You have specified an invalid channel to archive. | Ensure that the channel exists in the workspace and is not archived already. |
| Unable to unarchive channel. Reason: Channel_not_found | You have specified an invalid channel to unarchive. | Ensure that the channel exists in the workspace and is archived already. |
| Input error. Reason: No Channel provided | You have not specified a channel to perform the selected channel operation. | Ensure that you provide a channel in the Channel field and that it exists in this workspace. |
...
This example uses a series of Pipelines to demonstrate the different operations that you can perform on channels using the Channel Operations Snap. All operations carried out in this example are for demonstration purposes only and these Pipelines do not reflect any actual/real-time scenario.
- A Pipeline with two Channel Operations Snaps to create a channel and invite one or more users to it.
- A Pipeline with three Channel Operations Snaps to rename a channel and retrieve users and generic information about the channel.
- The Remove user Snap to remove the user from the channel
Example 1: Create a channel and Invite User to join
This Pipeline pipeline uses two features of the Channel Operations Snap – Snap – Create Channel and and Invite User. The first Channel Operations Snap is configured to create a new channel with a unique name defined as an expression. It creates the channel with the name vinchannel48873 and and displays its details in the output view.
| Channel Operations Snap (Create Channel) | Output |
|---|---|
| 
|
The next Snap invites a user to the new channel. It displays the result of the the Invite User operation operation in the output view.
| Channel Operations Snap (Invite User) | Output |
|---|---|
| 
|
Example 2: Rename a channel and view its details and subscribers
...
Based on the channel selected in this Snap, it returns the details of the channel. You can see these details in the output view.
Example 3: Remove user from the channel
This Channel Operations Snap removes the specified user from the channel. It displays the result of the Remove User operation in the output view.
| Channel Operations Snap (Remove User) | Output |
|---|---|
|
|
Downloads
| Note | ||
|---|---|---|
| ||
|
...