Teams - Create Channel

Owned by Anand Vedam
Last updated: May 07, 2024 by Gouri Bhagchandani
6 min read

In this article

Overview

You can use this Snap to create a channel for the selected team.

Snap Type

Teams - Create Channel Snap is a Write-type Snap that adds a channel within a team.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations

  • You can send up to a maximum of 3000 messages per app per day, to a given channel.

  • You can create up to 37 channels in a team besides the default channel - General.

Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

A document containing details of the channel to create such as channel name or description. 

Output

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • JSON Formatter + File Writer

A document containing details of the new channel. 

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon (): Indicates that you can add fields in the field set.

  • Remove icon (): Indicates that you can remove fields from the field set.

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

 

Default Value: Channel Operations
Example: Create Dev Channel

String

Specify a unique 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.

Team ID*

 

Default Value: N/A
Example: b22e8da4-17c1-45c0-baa9-47aed7344e92

String/Expression/Suggestion

Specify the ID of the team. Alternatively, click the  icon to fetch a list of team IDs associated with the account. 

Channel Name*

 

Default Value: N/A
Example: Marketing Discussions

String/Expression

Specify a name for the new channel. 

Channel Description

 

Default Value: N/A
Example: A private group to discuss marketing initiatives

String/Expression

Specify a description for the channel.

Private Channel

 

Default Value: Deselected

Checkbox

Select to create the specified channel as a private channel. 

Public and Private Channels

Public channels contain all team members, by default. You can add or remove members only in private channels.

Number of Retries

 

Default Value: 0
Example: 3

Integer/Expression

Specify the number of attempts the Snap makes to perform the selected operation in case of connection failure/unsuccessful attempts. 

To avoid 502 Bad Gateway error

Use a higher value (such as 3, 4, or more) in this field to ensure the Snap/Pipeline runs successfully. 

Retry Interval (seconds)

 

Default Value: 1
Example: 6

Integer/Expression

Specify the time interval in seconds between retry attempts.

Snap Execution

 

Default Value: Execute only
Example: Validate & Execute

Drop-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.

Troubleshooting

Error 

Reason 

Resolution

Error 

Reason 

Resolution

400 - Bad Request. Error in creating a channel.

The request to create the channel was invalid. 

Team ID needs to be a valid GUID.

401 - Invalid Authentication Token

The provided authentication token is either expired, invalid, or does not have the required permissions to access this resource.

Ensure that you provide valid access token.

Examples

Initiating activity in Microsoft Teams

The following example Pipeline demonstrates how you can use the Create Team Snap and some other Snaps in the Teams Snap Pack to begin team's activity within your Microsoft Teams instance. This example assumes that you have:

This Pipeline uses the OAuth2 user account (authorization code grant type) to create a team on behalf of a signed-in user and to allow begin their collaboration efforts. It demonstrates the following activities:

  • Creating a team

  • Adding members to the new team

  • Creating a public channel within the team

  • Collaborating through the channel

Creating a team

Use the Create Team Snap from the Teams Snap Pack to create the new team, as needed. For this Pipeline demonstration, the inputs for creating a team are passed using a Mapper Snap. 

Mapper Snap

Output

Mapper Snap

Output

 

The values for Team and Team_Desc are passed to the Create Team Snap. The Snap creates a new team in your Teams instance and returns the team's id and a confirmation message about the operation.

Create Team Snap

Output

Create Team Snap

Output

Adding members to a team

To add members to the team, connect a Team Operations Snap. Select Add Members as the Operation and provide the user IDs of the members and owners for the team, as needed.

Team Operations Snap to add members to a team

Output

Team Operations Snap to add members to a team

Output

 

 

Creating a channel in the team

Now, let us create a channel within this new team (using Create Channel Snap) and add members to this channel, as necessary. This Snap creates a new channel under the team and returns the channel details in its output.

Create Channel Snap

Output

Create Channel Snap

Output

 

Sending a message to a channel

Let us use these details to send our first message in the channel. To do so, we must connect a Send Channel Message Snap and pass the Team ID and Channel ID from the above output as inputs. The Send Channel Message Snap allows you to draft messages to the channel members using HTML markup. See the input for the Message field in the Snap.

Send Channel Message Snap

Output

Send Channel Message Snap

Output

 

 

Replying to a specific message

Similarly, you can use the Send Channel Message Snap to reply to a specific message in the channel (conversation) using its message ID. For demo purposes, we are using the id of the message sent above to reply to it.

Send Channel Message as a reply

Output

Send Channel Message as a reply

Output

 

Download this Pipeline.

Downloads

  File Modified

File Teams_FEP_2_CreateTeam_Channel_SendMessage.slp

Jan 07, 2021 by Anand Vedam

Snap Pack History



See Also

Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.