Create Channel

UiPath.Slack.Activities.Channels.CreateChannel

Overview

The Create Channel activity uses the Slack conversations.create API to create a new channel (Channel Name) in your worskpace. 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.

In the Body of the Activity

• ChannelName - The name of the channel that you want to create. Enter a String or String variable.
  • Channel name criteria: must be 80 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.
• Is Private Channel - Whether or not the new channel will be public or private. Enter a Boolean value or Boolean variable.
• ChannelId - The id of the created channel. If the DoNameValidation property is not selected, this property returns the modified name (see example below). Enter a String variable.
• New Channel Name - The name of the newly created created channel. Enter a String variable.

Properties

Common

• DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

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

Output

• ResponseStatus - The status of the request (success/failure information). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). The ResponseStatus object includes three properties that you can use in other activities.
  • Success - Boolean - Specifies whether the API request was successful.
  • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
  • Message - String - The error message.

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.