In this article
Overview
Use this Snap to create a channel for the selected 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 Input and Output
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing details of the channel to create such as channel name or description. |
Output | Document |
|
| A document containing details of the new channel. |
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. | Create Channel | Create Dev Channel |
Team ID | String/Expression/Suggestion | Required. Enter the ID of the team. Alternatively, click the icon to fetch a list of team IDs associated with the account. | N/A | b22e8da4-17c1-45c0-baa9-47aed7344e92 |
Channel Name | String/Expression | Required. Enter a name for the new channel. | N/A | Marketing Discussions |
Channel Description | String/Expression | Enter a description for the channel. | N/A | A private group to discuss marketing initiatives |
Private Channel | Check box | 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. | Not selected | Selected |
Number of Retries | String/Expression | Enter 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. | 0 | 3 |
Retry Interval (seconds) | String/Expression | Enter the time interval in seconds between retry 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. | 1 | 6 |
Snap Execution | Drop-down list | Select one of the three following modes in which the Snap executes:
| Execute only | Validate & Execute |
Troubleshooting
None.
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:
- Set up your application in Azure Portal with necessary permissions.
- Configured the required Snap account with necessary scopes.
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 |
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 |
---|---|
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 |
---|---|
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.
Create Channel Snap | Output |
---|---|
This Snap creates a new channel under the team and returns the channel details in its 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 | |
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 |
Downloads
Important steps to successfully reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.