Subscribe

UiPath Marketplace

The UiPath Marketplace Guide

Get Messages

Overview

The Get Messages activity uses the Slack conversations.list and conversations.history APIs to retrieve the most recent messages from a specified conversation (Conversation).

After retrieving the messages, the activity returns the properties in a Message[] object (Messages) that you can use as input property variables in subsequent activities (e.g., Message(0).Files in Download File, etc.).

How it Works

The following steps and message sequence diagram is an example of 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 Slack Scope activity to your project.
  3. Add the Get Messages activity inside the Slack Scope activity.
  4. Enter values for the Input properties.
  5. Create and enter a Message[] variable for your Output property.
  6. 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

Get Messages

Allowed values

Enter a String or String variable.

Notes

N/A

Input

Conversation

The conversation from which you want to get messages. A conversation can be messages from a specific channel or direct messages between one or more users.

Attributes

Details

Type

String or drop-down list

Required

Yes

Default value

Empty

Allowed values

Enter a valid conversation name String or use the drop-down list to select a conversation from your workspace.

Notes

Before you can select a conversation, the Slack Scope must be connected to the workspace. Connecting to the workspace is done by clicking the Connect button in the Slack Scope activity. After the connection is established, this button changes to Refresh.
The conversations included in the drop-down list are those that are available in the connected workspace only.
Direct messages between one or more users take the form of "mpdm-Person1--Person2--Person3-1".

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

Options

MarkAsRead

Specifies whether you want to mark the retrieved messages as read in your workspace.

Attributes

Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

When selected, all messages that are returned in the Message array (Messages) are marked as read in your Slack workspace.

MaxResults

The maximum number of messages that you want to be returned in the Message array.

Attributes

Details

Type

Int32

Required

No

Default value

100 (not displayed)

Allowed values

Enter a Int32 or Int32 variable.

Notes

N/A

Output

Messages

The messages found based on your specified Conversation.

Attributes

Details

Type

Message[]

UiPath.Slack.Models.Message

Required

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

Default value

Empty

Allowed values

Enter a Message[] variable.

Notes

If you plan to use the For Each activity to process the array output, select UiPath.Slack.Models.Message as the TypeArgument (see example image below).

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 6 months ago


Get Messages


Suggested Edits are limited on API Reference Pages

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