Subscribe

The UiPath Marketplace Guide

Create Channel

Overview

The Create Channel activity uses the Slack channels.create API to create a new channel (Channel Name) in your workspace. This activity automatically validates and modifies the channel name if it doesn't meet Slack's name criteria; you can turn this feature off and get an error response instead (DoNameValidation).

After creating your channel, the activity returns the channel name (ChannelId) that was added to your workspace.

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 Create Channel activity inside the Slack Scope activity.
  4. Enter values for the Input properties.
  5. Create and enter a String variable for your Output property.
  6. Run the activity.
    • Your input property values are sent to the channels.create API.
    • The API returns the String value to your output property variable.

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

Create Channel

Allowed values

Enter a String or String variable.

Notes

N/A

Input

ChannelName

The name of the channel that you want to create.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

Channel name criteria: must be 21 characters or less and only contain lowercase letters, numbers, hyphens, and underscores.
If the DoNameValidation property is not selected, the activity validates the entered channel name and modifies it to meet the above criteria. For example, if you enter "Slack Quickstart" the activity creates the channel, but modifies the name to slack-quickstart.
You have the option for the activity to return an error instead of modifying the name. Using the example above, if you select DoNameValidation, the activity doesn't create the channel and returns an error. To resolve this error, you must modify your channel name to meet the criteria above and run the activity again.

DoNameValidation

Specifies whether to return an error for invalid channel names or modify the name to meet the channel name criteria.

Attributes

Details

Type

Checkbox

Required

Yes

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

If this property is not selected, the activity validates the ChannelName and modifies it to meet the channel name criteria. For example, if you enter "Slack Quickstart" the activity creates the channel, but modifies the name to slack-quickstart.
If this property is selected, the activity doesn't create the channel and returns an error. To resolve this error, you must modify your ChannelName to meet the criteria above and run the activity again.

Misc

Private

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

Attributes

Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A

Output

ChannelId

The name of the created channel. If the DoNameValidation property is not selected, this property returns the modified name (see example below).

Attributes

Details

Type

String

Required

No (recommended to validate the name or use the variable as an input property in other activities).

Default value

Empty

Allowed values

Enter a String variable.

Notes

N/A

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


Create Channel


Suggested Edits are limited on API Reference Pages

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