Input 

Document

• Min: 0

• Max: 1

• Mapper

• Copy

Example of an input document:

Output

Document

• Min: 0

• Max: 1

• Mapper

• Router

The output document contains:

• Message ID - Unique identifier of the sent message

• Confirmation details - Status and metadata about the message delivery

• Timestamp - When the message was sent

• Channel information - Details about where the message was posted

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

Label*

String

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

Default Value: Send Message as Bot
Example: Send Message as Bot

Service URL*

String/Expression

Specify the Service URL.

Default Value: https://smba.trafficmanager.net/teams
Example: https://smba.trafficmanager.net/amer/v3/conversations/19:abcd1234efgh5678@thread.tacv2/activitie

Conversation ID

String/Expression

The Conversation ID is a unique identifier for a Microsoft Teams conversation (channel or chat) that you need to obtain from Microsoft Teams.

You can use any of the following methods to obtain the Conversation ID:

1. From Teams Web/Desktop App:

   1. Open the Teams channel or chat where you want to send the message.

   2. Copy the URL in your browser or copy the link from the ellipsis of the conversation

   3. The Conversation ID is embedded in the URL format like: 19:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@thread.tacv2

2. Using Microsoft Graph API:

   1. Call the Graph API to list conversations/channels.

   2. Use endpoints like /teams/{team-id}/channels to get channel information.

   3. The response will include the Conversation ID for each channel.

3. From Teams Bot Framework

   1. If you're building a bot, the conversation ID is provided in the activity context when your bot receives messages.

   2. It's available in the conversation.id property of incoming activities

• Teams Admin Center:

  • For administrators, you can find conversation details through the Teams admin portal.

  • Navigate to the specific team/channel to view its properties.

For production use, you'd typically want to:

• Make this a pipeline parameter instead of hardcoding it.

• Or retrieve it dynamically from an API call.

• Or pass it as input data to your pipeline.

Default Value: N/A
Example:

• '19:fec55eed11e94378b2846b3d4bf48ea9@thread.tacv2'

• $conversationID1

Text format*

Dropdown list

The format for the text message. The supported formats are Plain/Markdown and XML.

Default Value: N/A
Example: Plain

Message*

String/Expression

The actual content that will be sent to the Microsoft Teams channel or chat. It contains the body text of the message that your bot will post to Teams, and users will see in the conversation.

This field supports Plain text, Rich formatting text, and Unicode characters. You can use expressions to make messages dynamic. For example, "Alert: Server ${serverName} is down. Status: ${status}"

Default Value: N/A
Example:
CRITICAL ALERT 🚨
Server: web-prod-01
Status: DOWN
Time: 2024-10-22 14:30 UTC
Action Required: Immediate investigation needed

Images

Use this field set to attach image files to your Teams messages. This allows your bot to send visual content along with text messages to enhance communication and provide richer information.

URL/Data

String/Expression

The URL for the images that are publicly accessible or Base64-encoded image data for embedded images.

Default Value: N/A
Example: https://www.snaplogic.com/media-kit/Logocombo_SnapLogic_RGB.png

Content type

String/Expression

The format of the message content to send to Microsoft Teams. This field determines how Teams interprets, processes, and renders your message content.

Default Value: N/A
Example: image/jpeg

Name

String

The name of the image to help identify your bot in Teams conversations.

Default Value: N/A
Example: "System Alert Bot" - Messages appear from "System Alert Bot"

Number of Retries

String/Expression

The maximum number of attempts to attempt when the Snap fails. 

Default Value: N/A
Example: 3

Retry interval (seconds)

String/Expression

The time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception.

Default Value: N/A
Example: 1

Snap Execution

Dropdown list

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

• Validate & Execute: Performs limited execution of the Snap based on Preview Document Count value in User settings and generates a data preview during pipeline validation. Subsequently, 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 that are downstream from it.

Default Value: 
Example: Validate & Execute