In this article
Overview
Use this Snap to perform the following Channel operations in your Slack workspace:
- 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.
Slack Scopes required
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 (Doc in Progress) for information on defining Scopes for your app.
To | Bot Token Accounts | User Token Accounts ( user_scope ) |
---|---|---|
| channels:manage
|
|
| channels:read | channels:read |
Unarchive channel | N/A |
|
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations
- Snaps in this Snap Pack use conditional display/hiding of fields. So, ensure that you always use the New Form UI (and not the classic UI) for the Snaps to function as designed/expected.
- Channel operations Archive Channel and Unarchive Channel cannot be performed using a Bot Token account. Use a User Token account instead.
Known Issues
None.
Snap Input and Output
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing details required for the selected channel operation. |
Output | Document |
|
| A document containing the result (success/failure) of the selected channel operation. |
Snap Settings
Parameter Name | Data Type | Description | Default Value | Example |
---|---|---|---|---|
Label | String | Specify a name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | 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. Select a channel from the list of suggested channels to perform the selected channel operation. Alternatively, you can enter the channel name and/or channel ID in one of the following formats.
| N/A | #testprivate:G019B3ETYMB |
Users | String/Expression/Suggestion | Required for channel operation - Invite User. Select a user from the suggested values which are typically the list of users available in the workspace. Alternatively, you can enter one or more usernames and/or user IDs, separated by commas, in one of the following formats:
The specified set of users are invited to join the selected channel. | N/A | @user.name:W01A94P7MK1 |
User | String/Expression/Suggestion | Required for channel operation - Remove User. Select a user from the suggested values which are typically the list of users available in the workspace. Alternatively, you can enter one or more usernames and/or user IDs, separated by commas, in one of the following formats:
The specified user is removed from the selected channel. | ||
Name | String/Expression | Required for channel operation - Create Channel. Enter a name for the new channel. | N/A | Support_Vertical |
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 |
Troubleshooting
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 user to be removed currently exists in 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. |
Examples
<Example under revision>
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.