Versions Compared

Old Version 2

changes.mady.by.user Anand Vedam

Saved on

compared with

New Version 3

changes.mady.by.user Anand Vedam

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

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

Image Added

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/account. See Scopes for more information.

To

Bot Token Accounts
(scope)

User Token Accounts
(user_scope)
  • Archive Channel
  • Create Channel
  • Invite User
  • Remove User
  • Rename Channel
Channels:manage

Channels:write

  • List Members in a Channel
  • Retrieve Channel Info
Channels:readChannels:read

Unarchive Channel

N/AChannels:write

Support for Ultra Pipelines

Capture if Ultra Mode is supported. If the Snap requires certain configurations to support Ultra mention those as well.   

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/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min:0
  • Max:1
  • Mapper
  • Copy
  • JSON Generator
A document containing details required for a specific Channel operation.
Output

Document

  • Min:1
  • Max:1
  • JSON Formatter
  • CSV Parser

A document containing the result (success/failure) of performing the selected Channel operation.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Insert excerpt
File Writer
File Writer
nopaneltrue
Channel OperationsChannel Operations
OperationDrop-down list

Select an operation from the following list of permitted Channel operations. The number and list of fields required for the operation are displayed after you select an operation to perform.

  • List Members: To retrieve the list of users that subscribed to a specific Channel. Also, select the Channel from the suggested list of Channels. 
  • Invite User: To associate/add a user from the Workspace to a specific Channel. Also, select a User from the suggested list of users. 
  • Remove User: To dissociate/delete a user from a specific Channel. Also, select a User from the suggested list of users. 
  • Channel Info: To view the details of a specific Channel, like its creation date, purpose, creator, topic, locale and the current number of members in the Channel, and so on. Also, select the Channel from the suggested list of Channels.
  • Create Channel: To create a new Channel in the Workspace. Also, enter the name for the new Channel in Name field.
  • Rename Channel: To rename an existing Channel in the Workspace. Also, select the Channel and enter the new name for the Channel in the New Name field.
  • Archive Channel: To archive an existing Channel. Also, select the Channel to archive.
  • Unarchive Channel: To unarchive an archived Channel. Also select the archived Channel to unarchive.
List MembersInvite User
ChannelString/Expression/Suggestion

Conditional: Required for all Channel operations except Create Channel. Select a Channel from the list of suggested Channels to perform the selected Channel operation on. Alternatively, you can enter the Channel name and/or Channel ID in one of the following formats.

  • #Channel.name:<11-character alphanumeric Channel ID> OR
  • #Channel.name OR
  • <11-character alphanumeric Channel ID>
N/A#testprivate:G019B3ETYMB
User/UsersString/Expression/Suggestion

Conditional: Required for Channel operations - Invite User, 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.

  • @user.name:<11-character alphanumeric user ID> OR
  • @user.name OR
  • @<11-character alphanumeric user ID>

The specified set of users are invited to join or removed from the selected Channel accordingly.

N/A@user.name:W01A94P7MK1
NameString/ExpressionConditional: Required for Channel operation - Create Channel. Enter a name for the new Channel.N/ASupport_Vertical
New NameString/Expression/SuggestionConditional: Required for Channel operation - Rename Channel. Enter the new name for the Channel.N/AReleaseTeam_Channel
Snap ExecutionDrop-down list

Select one of the three following modes in which the Snap executes:

  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled. Disables the Snap and all Snaps downstream from it.

Execute onlyValidate & Execute

Troubleshooting

ErrorReasonResolution
Failure: Unable to rename the given Channel.invalid_name_specials

Ensure the token and the inputs are valid, and try again; contact support team if the problem persists.

Failure: Unable to kick user from Channel.Channel_not_foundEnsure the token and the inputs are valid, and try again; contact support team if the problem persists.
Failure: Unable to archive Channel.Channel_not_foundEnsure the token and the inputs are valid, and try again; contact support team if the problem persists.
Failure: Unable to unarchive Channel.Channel_not_foundEnsure the token and the inputs are valid, and try again; contact support team if the problem persists.
Failure: Input error.No Channel providedSupply an existing Channel, and proceed

Examples

<Example under revision>

Downloads

Note
titleImportant Steps to Successfully Reuse Pipelines
  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

Attachments
patterns*.slp, *.zip


Insert excerpt
Slack Snap Pack (Doc in Progress)
Slack Snap Pack (Doc in Progress)
nopaneltrue

...

See Also