marketplace
latest
false
UiPath logo, featuring letters U and I in white
Marketplace User Guide
Last updated Sep 5, 2024

Create Channel

Overview

The Create Channel activity calls the Microsoft Graph CreateChannel API to create a new channel (Name) in your specified team (TeamId).

After creating your new channel, the activity outputs its properties in a Channel object that you can use as input variables in subsequent activities (e.g., Channel.Id in Get Messages, Send 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. Add an activity or run an external process that outputs a Team.Id value (e.g.,Get Teams).
  4. Add the Create Channel activity inside the Microsoft Teams Scope activity.
  5. Enter values for the Input properties.
  6. Create and enter a Channel variable for your Output property.
  7. Run the activity.

    • Your input property values are sent to the CreateChannel API.
    • The API returns the Channel 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

Name

The display name for your new channel.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

This value is displayed in the Microsoft Teams app.

TeamId

The Id of the Team object that you want to create the channel in.

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)

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

Description

An optional description for the channel.

Attributes

Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

N/A

Output

Channel

The Channel object that represents your created channel.

Attributes

Details

Type

Channel

Required

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

Default value

Empty

Allowed values

Enter a Channel variable.

Notes

The variable you create for this property can be used as an input variable in subsequent activities (e.g., Channel.Id in Get Messages, Send Message, etc.).
The Channel object includes multiple properties and relationships that you can use in other activities.The example image below shows some of the properties that you can return.
Note - some properties listed in the designer are not applicable to the Channel object (e.g., Visibility). For a list of the applicable Team properties, visit the links above.

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.



  • Overview
  • How It Works
  • Properties
  • Common
  • Input
  • Misc
  • Options
  • Output
  • Example

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.