Skip to end of metadata
Go to start of metadata

Introduction

A Microsoft Teams Send Message activity sends a message to a selected team and channel in a Microsoft Teams endpoint and is intended to be used as a target to consume data in an operation. After configuring a Microsoft Teams connection, you can configure as many Microsoft Teams activities as you like for each Microsoft Teams connection.

Creating a Microsoft Teams Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Use the Show dropdown to filter on Endpoints, and then click the Microsoft Teams connection block to display activities that are available to be used with a Microsoft Teams connection:

Microsoft Teams activities

To create an activity that can be configured, drag a Microsoft Teams Send Message activity from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Configuring a Microsoft Teams Send Message Activity

Follow these steps to configure a Microsoft Teams Send Message activity:

Step 1: Enter a Name and Select a Team

Microsoft Teams Send Message Activity Configuration Step 1

  • Name: Enter a name to use to identify the Microsoft Teams Send Message activity. The name must be unique for each Microsoft Teams Send Message activity and must not contain forward slashes (/) or colons (:).

  • Select a Team: This section displays teams available in the Microsoft Teams endpoint. When reopening an existing activity configuration, only the selected team is displayed instead of reloading the entire team list.

    • Selected Team: After a team is selected, it is listed here.

    • Search: Enter any part of the team name into the search box to filter the list of teams. The search is not case-sensitive. If teams are already displayed within the table, the table results are filtered in real time with each keystroke. To reload teams from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload teams from the Microsoft Teams endpoint. This may be useful if you have recently added teams to Microsoft Teams. This action refreshes all metadata used to build the table of teams displayed in the configuration.

    • Selecting a Team: Within the table, click anywhere on a row to select a team. Only one team can be selected. The information available for each team is fetched from the Microsoft Teams endpoint:

      • Name: The team name from Microsoft Teams.

      • Description: The team description from Microsoft Teams.

    TIP: If the table does not populate with available teams, the Microsoft Teams connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select a Channel

Microsoft Teams Send Message Activity Configuration Step 2

  • Select a Channel: This section displays channels available in the Microsoft Teams endpoint. When reopening an existing activity configuration, only the selected channel is displayed instead of reloading the entire channel list.

    • Selected Team: The team selected in the previous step is listed here.

    • Selected Channel: After a channel is selected, it is listed here.

    • Search: Enter any part of the channel name into the search box to filter the list of channels. The search is not case-sensitive. If channels are already displayed within the table, the table results are filtered in real time with each keystroke. To reload channels from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload channels from the Microsoft Teams endpoint. This may be useful if you have recently added channels to Microsoft Teams. This action refreshes all metadata used to build the table of channels displayed in the configuration.

    • Selecting a Channel: Within the table, click anywhere on a row to select a channel. Only one channel can be selected. The information available for each channel is fetched from the Microsoft Teams endpoint:

      • Name: The channel name from Microsoft Teams.

      • Description: The channel description from Microsoft Teams.

    TIP: If the table does not populate with available channels, the Microsoft Teams connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the Data Schemas

Microsoft Teams Send Message Activity Configuration Step 3

  • Data Schema: The request and response data schemas for Microsoft Teams are displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The Microsoft Teams connector uses the Microsoft Graph REST API v1.0. Refer to the API documentation for information on the schema fields.

    These are the schema fields shown in the example screenshot above:

    • Request:

      Request Schema Field/NodeNotes
      sendMesssageRequestNode of the Send Message request
      attachmentNode of the attachment
      fileNameAttachment file name
      fileDataAttachment data
      messageNode of the message

      NOTE: Attaching files larger than 4MB will cause the operation to fail and errors to be written to the log. As a workaround, split a ZIP file into smaller, separate files.

    • Response:

      Response Schema Field/NodeNotes
      sendMessageResponseNode of the Send Message response
      summaryMessage summary
      attachmentsNode of the attachments
      itemNode of the attachment item
      contentUrlAttachment URL
      nameAttachment name
      idAttachment ID
      contentTypeAttachment content type
      contentContent of the attachment
      thumbnailUrlURL for the thumbnail of the attachment
      lastEditedDateTimeThe last date and time the attachments were edited
  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Microsoft Teams endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a Microsoft Teams Send Message activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

After a Microsoft Teams activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.

Microsoft Teams Send Message activities can be used as a target with these operation patterns:

Other patterns are not valid using Microsoft Teams Send Message activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a Microsoft Teams Send Message activity in the Two-Transformation Pattern. In this example, the first transformation (Send Message Request) creates a request structure that is passed to the Microsoft Teams Send Message activity. The second transformation (Send Message Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Microsoft Teams Send Message Response) and a message is then logged by the Write to Operation Log script:

Microsoft Teams Send Message operation

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

  • No labels