Skip to main content
Version: 8.4

Microsoft Teams Connector

The Microsoft Teams Connector is an outbound Connector that allows you to connect your BPMN process with Microsoft Teams to manage interactions.

Prerequisites

To use the Microsoft Teams Connector, you need to have a Microsoft Teams account and relevant permissions or the registered application in the Azure Active Directory (visit how to register the app for more information) alongside the relevant Microsoft Graph API permissions.

Some methods can use protected Microsoft Teams APIs. Read more on how to request access to protected APIs.

note

It is highly recommended to use Camunda secrets to store credentials so you don't expose sensitive information directly from the process. See managing secrets to learn more.

Create a Microsoft Teams Connector task

To use the Microsoft Teams Connector in your process, either change the type of existing task by clicking on it and using the wrench-shaped Change type context menu icon, or create a new Connector task by using the Append Connector context menu. Follow our guide to using Connectors to learn more.

Make your Microsoft Teams Connector executable

To work with Microsoft Teams, choose the required connection type in the Authentication section and complete the mandatory fields highlighted in red in the Connector properties panel:

note

All the mandatory and non-mandatory fields depending on the authentication selection you choose are covered in the upcoming sections.

Authentication

Choose among the available Microsoft Teams Connectors according to your authentication requirements. The Microsoft Teams Connector uses the Microsoft Graph API. Visit the Microsoft Graph auth overview for more information on the Microsoft Graph API authentication.

First, you must have a user account with Microsoft Teams with the necessary permissions. See more at in Microsoft Teams overview. If you don't have administration roles and permissions, ask your Microsoft Teams administrator to add required permissions to work with the Microsoft Teams Connector.

Next, you will choose the type of connection.

Bearer Token type authentication

For a Bearer Token type authentication, take the following steps:

  1. Click the Bearer Token connection type in the Authentication section.
  2. Set Bearer Token to Bearer Token.

Visit Microsoft Teams Access Token for more information.

Options to obtain an access token

Refresh Token type authentication

For a Refresh Token type authentication, take the following steps:

  1. Click the Refresh Token connection type in the Authentication section.
  2. Set Refresh Token to Refresh Token. Read more on how to get a refresh token.
  3. Set Tenant id to Tenant ID. Your Microsoft Teams tenant ID is a unique identifier. Read more on how to find a tenant ID.
  4. Set the Client ID field: the application ID that the Azure app registration portal assigned to your app.
  5. Set the Secret ID field: the client secret that you created in the app registration portal for your app.

Client credentials type authentication

For a Client credentials type authentication, take the following steps:

  1. Click the Client credentials connection type in the Authentication section.
  2. Set Tenant id to Tenant ID. Your Microsoft Teams tenant ID is a unique identifier. See more on how to find a tenant ID.
  3. Set the Client ID field: the application ID that the Azure app registration portal assigned to your app.
  4. Set the Secret ID field: the client secret that you created in the app registration portal for your app.
note

With Client credentials type authentication, some methods of the Microsoft Teams Connector may not be available. Find more details in the chat methods table and channel methods table.

Conversation type and method

In the Operation section, choose a conversation type of either Chat or Channel. Then, choose one of the suggested methods.

For example, if you want to send a message in a Microsoft Teams channel, choose the conversation type Channel and method Send message in channel.

Data section

Chat conversation type

Properties

PropertyMethodsRequiredTypeDescription
Chat IDGet chat by id
List chat members
Send message in chat
List messages in chat
Get message in chat
List chat members
YesstringMicrosoft Teams chat id
ContentSend message in chatYestextContent that will be sent to chat
Content TypeSend message in chatYesdropdownContent type of body message
Chat typeCreate a new chatYesdropdownClick one on one to create a one-on-one chat or group to create a group chat.
TopicCreate a new chatNostringTopic of chat
MembersCreate a new chatYesFEEL expressionSee members property to learn more.
TopList messages in chatNonumbersControls the number of items per response; maximum allowed top value is 50.
Order byList messages in chatYesdropdownCan order by 'lastModifiedDateTime' and 'createdDateTime'.
Expand responseGet chat by idYesdropdownChoose
FilterList messages in chatNostringSets the date range filter for the lastModifiedDateTime and createdDateTime properties. Learn more about filtering.
Message IDGet message in chatYesstringMicrosoft Teams chat message id
Expand response

For method Get chat by ID, you can get more information in the response by using the dropdown property Expand response. You can choose one of the following values:

  • select With chat members, to get information about chat members.
  • select With last message preview, to get last message in chat. Note: This function doesn't work with client credentials type authentication, make sure that you use another authentication type.
  • select Without expand, to get main information about chat.
Members property

The members property must contain a list of members:

PropertyTypeRequired
userIdstringYes, if 'userPrincipalName' is not set
userPrincipalNamestringYes, if 'userId' is not set
rolesstring arrayYes
[
{
"userId": "abc01234-0c7f-012c-9876-&812dsfw2",
"roles": ["owner"]
},
{
"principalName": "john.dou@mail.com",
"roles": ["owner"]
}
]

Chat methods

MethodUse protected APIsAvailable for client credentials type authenticationLink to method documentation with required permissions and return value
Create a new chatfalsetruehttps://learn.microsoft.com/en-us/graph/api/chat-post
Get chat by IDfalsetruehttps://learn.microsoft.com/en-us/graph/api/chat-get
List chatsfalsetruehttps://learn.microsoft.com/en-us/graph/api/chat-list
List chat membersfalsefalsehttps://learn.microsoft.com/en-us/graph/api/chat-list-members
Send message in chatfalsefalsehttps://learn.microsoft.com/en-us/graph/api/chat-post-messages
Get message in chatfalsetruehttps://learn.microsoft.com/en-us/graph/api/chatmessage-get
List messages in chattruetruehttps://learn.microsoft.com/en-us/graph/api/chat-list-messages

Channel conversation type

Properties

PropertyMethodsRequiredTypeDescription
Group IDCreate channel
Get channel
List channels
Send message to channel
Get channel message
List channel messages
List message replies
List members
YesstringMicrosoft Teams group id
Channel IDGet channel
List channels
Send message to channel
Get channel message
List channel messages
List message replies
List members
YesstringMicrosoft Teams channel id
Display nameCreate channelNostringDisplayed name of new Microsoft Teams channel
DescriptionCreate channelNotextDescription of new Microsoft Teams channel
Channel membership typeCreate channelYesdropdownSee teams-channels-overview for more information
OwnerCreate channel (if Channel membership type != STANDARD)YesstringChannel owner; Microsoft Teams user id or Microsoft Teams principal name
FilterList channelsNostringThe search filter. Learn more about filtering
ContentSend message to channelYestextContent that will be sent to chat
Content TypeSend message to channelYesdropdownContent type of body message
Message IDGet channel messageYesstringMessage id of Microsoft Teams in channel
TopList channel messagesNonumbersControls the number of items per response
With repliesList channel messagesYesbooleanChoose FALSE for get messages without replies
Choose FALSE for get messages without replies
Message IDList message repliesYesstringMicrosoft Teams channel message id

Channel methods

MethodUse protected APIsAvailable for client credentials type authenticationLink to method documentation with required permissions and return value
Create channelfalsetruehttps://learn.microsoft.com/en-us/graph/api/channel-post
Get channelfalsetruehttps://learn.microsoft.com/en-us/graph/api/channel-get
List channelsfalsetruehttps://learn.microsoft.com/en-us/graph/api/channel-list
Send message to channelfalsefalsehttps://learn.microsoft.com/en-us/graph/api/channel-post-messages
Get channel messagetruetruehttps://learn.microsoft.com/en-us/graph/api/chatmessage-get
List channel messagestruetruehttps://learn.microsoft.com/en-us/graph/api/channel-list-messages
List message repliestruetruehttps://learn.microsoft.com/en-us/graph/api/chatmessage-list-replies
List membersfalsetruehttps://learn.microsoft.com/en-us/graph/api/channel-list-members

Microsoft Teams Connector response

The Microsoft Teams Connector returns the Microsoft Graph API response in result wrapper:

{
"result": {
"chatType": "ONE_ON_ONE",
"createdDateTime": {
"dateTime": {
"date": {
"year": 2022,
"month": 11,
"day": 29
},
"time": {
"hour": 18,
"minute": 10,
"second": 33,
"nano": 361000000
}
},
"offset": {
"totalSeconds": 0
}
},
"lastUpdatedDateTime": {
"dateTime": {
"date": {
"year": 2022,
"month": 11,
"day": 29
},
"time": {
"hour": 18,
"minute": 10,
"second": 33,
"nano": 361000000
}
},
"offset": {
"totalSeconds": 0
}
},
"tenantId": "0000000-0000-0000-0000-000000000",
"webUrl": "https://teams.microsoft.com/l/chat/19%3Aefb08ac3-0000f-0000-0000-example-chat-id_fe35bf61-0000-0000-0000-ddc97d8903d4%40unq.gbl.spaces/0?tenantId=00000-0000-0000-0000-00000000",
"id": "19%3Aefb08ac3-0000f-0000-0000-example-chat-id_fe35bf61-0000-0000-0000-ddc97d8903d4%40unq.gbl.spaces"
}
}

See channel resource type to find the response for the required method for a channel conversation type, or see chat resource type to find the response for the required method for a chat conversation type.

You can use an output mapping to map the response:

  1. Use Result Variable to store the response in a process variable. For example, myResultVariable.
  2. Use Result Expression to map fields from the response into process variables. For example:
= {
"chatId": result.id,
"tenantId": result.tenantId
}