UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Send Message

Overview

The Send Message activity calls the Microsoft Graph CreateChatMessage or CreateChatMessage - in a channel API to send a message (Body, BodyType, Importance, Subject) to a specified chat (ChatId) or channel (ChannelId) and team (TeamID).

After sending the message, the activity outputs the id of the sent message (MessageId) as a String that you can use as in input variable in subsequent activities (e.g., Get Message Replies, Get Message, etc.).

How it works

The following steps and message sequence diagram is an example how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Microsoft Teams Scope activity to your project.
  3. Complete one of the following two options (A or B):
    A. Add an activity or run an external process that outputs a Chat.Id value (e.g., Get Chats).
    B. Add an activity or run an external process that outputs a Team.Id value (e.g.,Get Teams) AND an activity or external process that outputs a Channel.Id value (e.g., Get Channels).
  4. Add the Send Message activity inside the Microsoft Teams Scope activity.
  5. Enter values for the Channel and Message properties.
  6. Create and enter a String variable for your Output property.
  7. Run the activity.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Send Message

Allowed values

Enter a String or String variable.

Notes

N/A


Channel

TeamId

The Id of the Team object that contains the channel you want to send a message to.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • To get the Team.Id value, use an external process or activity that includes the Team.Id value in its output (e.g., Get Teams or external API call)

ChannelId

The Id of the Channel object that you want to send a message to.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • To get the Channel.Id value, use an external process or activity that includes the Channel.Id value in its output (e.g., Get Channels or external API call)

Chat

ChatId

The Id of the Chat object that you want to send the message to.

Attributes
Details

Type

String

Required

Yes (if TeamId and ChannelId are empty)

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • To get the Chat.Id value, use an external process or activity that includes the Chat.Id value in its output (e.g., Get Chats or external API call)
  • Either (ChatId) or (TeamId and ChannelId) are required.

Message

Body

The message content that you to send.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • Enter your value according to the BodyType value ( BodyType.Text or BodyType.Html).

BodyType

The type of content that you want to send in your Body.

Attributes
Details

Type

BodyType

Required

No

Default value

Empty

Allowed values

Enter a BodyType or BodyType variable

Notes

  • Enter one of the following two accepted values:
    • BodyType.Text
    • BodyType.Html

Importance

The importance of the reply message.

Attributes
Details

Type

ChatMessageImportance

Required

No

Default value

Empty

Allowed values

Enter a ChatMessageImportance or ChatMessageImportance variable.

Notes

  • Enter one of the following three accepted values:
    • ChatMessageImportance.Normal
    • ChatMessageImportance.High
    • ChatMessageImportance.Urgent

Subject

The subject of the reply message.

Attributes
Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String or String variable

Notes

N/A


Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Output

MessageId

The id of the sent message.

Attributes
Details

Type

String

Required

No (required if you plan to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a String variable.

Notes


Example

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guides.

Updated 3 months ago


Send Message


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.