Versions Compared

Old Version 22

changes.mady.by.user Amritesh Singh

Saved on

compared with

New Version 23

changes.mady.by.user Amritesh Singh

Saved on

Key

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

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

Use You can use this Snap to send/reply to a message in the specified channel. Image Removed

...

Snap Type

Teams - Send Channel Message Snap is a Write-type Snap that sends a text message to a channel.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.  

Limitations

  • Does not work with application-based accounts.

  • You can send up

    to a

    to a maximum of 3000 messages per app per day, to a given channel.

Known Issues

None.

Snap

...

Views

Parameter NameData TypeDescriptionDefault ValueExample LabelString Insert excerptFile WriterFile WriternopaneltrueSend Channel MessageConfirmation SenderMessageString/ExpressionRequired. Enter the

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 the body of the message, team ID, or channel ID.

Output

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • JSON Formatter + File Writer

A document containing details of the message such as the message ID.

Snap Settings

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

Info

  • Asterisk (*): Indicates a mandatory field.

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

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

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

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

Field Name

Field Type

Description

Label*

 

Default Value: Send Channel Message
Example: Confirmation Sender

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.

Message*

Default Value: N/A
Example: <h1>Welcome to the channel</h1>

String/Expression

Specify the message to send to the specified channel. You can either use plain text or rich text using the markdown supported by Microsoft Teams. See the input for

the 

the Message

 field Team ID

 field of Send Channel Message Snap in the Example Pipeline below, for more details.  

N/A<h1>Welcome to the channel</h1>

Team ID*

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

String/Expression/Suggestion

Required. Enter the

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

N/Ab22e8da4-17c1-45c0-baa9-47aed7344e92Channel ID

Channel ID*

Default Value: N/A
Example: Chat, teams, channels and apps : 12:34ab567d89012b34b0fba40f987f2f3d@thread.tacv2

String/Expression/Suggestion

Required. Enter the

Specify the ID of the target channel. Alternatively, click the Image Modified icon to fetch a list of channel IDs associated with the specified team. 

N/AChat, teams, channels and apps : 12:34ab567d89012b34b0fba40f987f2f3d@thread.tacv2

Existing Message ID (if reply)

Default Value: N/A
Example: 1234556677

String/Expression

Enter the

Specify the ID of the message for which to post a reply.

N/A1234556677

Number of Retries

Default Value: 0
Example: 3

String/Expression

Enter the

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

Info
title

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. 

03

Retry Interval (seconds)

Default Value: 1
Example: 6

String/Expression

Enter the

Specify the time interval in seconds between retry attempts.

Info
titleSnap ExecutionDrop-down

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. 

16

Snap Execution

Default Value: Execute only
Example: Validate & Execute

Dropdown 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

  • execution without generating preview data.

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

Execute only

Validate & Execute

Troubleshooting

None.

Examples

...

The following example Pipeline demonstrates how you can use the Send Channel Message 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

  • Collaboration 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

Image Removed

Output

Output
Image Added
Image Removed
Image Added

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

Image Removed
Image Added
Image Removed
Image Added

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

Image Removed
Image Added
Image Removed
Image Added

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

Image Removed
Image Added

Image Removed
Image Added

This Snap creates a new channel under the team and returns the channel details in its output.

...

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

Image Removed

Output

Output
Image Added

Image Removed

Image Added

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

Image Removed

Output

Image Removed

...

Image AddedImage Added

Downloads

title
Note
Info

Important 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

Snap Pack History

Expand

Multiexcerpt include macro
nameTeams_SPH
templateData[]
pageTeams Snap Pack
addpanelfalse

...

Related Content