Skip to main content

Microsoft Teams Component

Manage the teams, groups, channels, and messages associated with your Microsoft Teams account

Component key: ms-teams

Description#

Microsoft Teams is a business communication platform developed by Microsoft, as part of the Microsoft 365 family of products. This component allows you to easily manage teams, groups, channels, and messages inside of your Microsoft Teams account.

Authorization Notes#

The Microsoft Teams component authenticates requests through the Microsoft Graph API. To configure an OAuth 2.0 credential you must first create an application through Active Directory in the Microsoft Azure portal. For more information regarding authenticating against the Microsoft Graph API refer to the Microsoft docs. Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.

  • For Client ID and Client Secret enter the values that you got from the Microsoft Azure Portal.
  • For Scopes and permission choose from the options found on the Microsoft Graph API docs
  • For Authorization URL enter https://login.microsoftonline.com/{Tenant-ID}/oauth2/v2.0/authorize Tenant-ID is a value you obtain in Azure Active Directory.
  • For Access Token URL enter https://login.microsoftonline.com/{Tenant-ID}/oauth2/v2.0/token Tenant-ID is a value you obtain in Azure Active Directory.

Triggers#

Webhook#

Trigger for handling webhooks from Microsoft Teams | key: webhook

You can configure a Microsoft Teams outgoing webhook to send information to a Prismatic webhook URL under certain conditions (a "Team" is created, a "User" is added to a team, etc.).

For more information on configuring webhooks refer to the Microsoft Graph API Docs

Additionally, you can reference a trigger's results.webhookUrls to create a webhook in a deploy-triggered flow. That'll configure webhooks to point to an instance when that instance is deployed to a customer.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "response": { "statusCode": 200, "contentType": "application/json" },  "payload": {    "headers": {      "accept": "*/*",      "Content-Type": "application/json",      "User-Agent": "Shopify-Captain-Hook",      "Host": "hooks.example.prismatic.io"    },    "body": { "data": {} },    "rawBody": {      "data": { "type": "Buffer", "data": [69, 120, 97, 109, 112, 108, 101] }    },    "queryParameters": None,    "webhookUrls": {      "Flow 1": "https://hooks.example.prismatic.io/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA=="    },    "webhookApiKeys": { "Flow 1": ["abc-123"] },    "customer": {      "externalId": "customer-example-external-id",      "name": "John Doe"    }  }}

Actions#

Add Group Member#

Add a member to an existing group | key: addGroupMember

InputKeyNotesExample

Group Id

string
/ Required
groupIdProvide a string value for the group Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

User Id

string
/ Required
userIdProvide a string value for the Id of the user.37635f8e-82d1-example-8ba4-af6e8985427f

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Add Group Owner#

Add an owner (admin) to an existing group | key: addGroupOwner

InputKeyNotesExample

Group Id

string
/ Required
groupIdProvide a string value for the group Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

User Id

string
/ Required
userIdProvide a string value for the Id of the user.37635f8e-82d1-example-8ba4-af6e8985427f

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Add Team Member#

Add a new member to the team | key: addMember

InputKeyNotesExample

Roles

string
Value List
rolesFor each item, provide a string value containing a role you would like to assign the user.owner

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

User Id

string
/ Required
userIdProvide a string value for the Id of the user.37635f8e-82d1-example-8ba4-af6e8985427f

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Archive Team#

Archive the specified team | key: archiveTeam

InputKeyNotesExample

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Channel#

Create a channel inside a team | key: createChannel

InputKeyDefaultNotesExample

Channel Description

string
/ Required
channelDescriptionProvide a string value for the channel description.This is an example description

Channel Name

string
/ Required
channelNameProvide a string value for the channel name.myChannel

Membership Type

string
/ Required
membershipTypeThe type of the channel. Can be set during creation and can't be changed. Possible values are: standard - Channel inherits the list of members of the parent team; private - Channel can have members that are a subset of all the members on the parent team.

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

Visibility

string
/ Required
visibilitypublicThe visibility of the group and team. Defaults to Public.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Team#

Create a new team | key: createTeam

InputKeyDefaultNotesExample

Allow users to create/update channels

boolean
allowCreateUpdateChannelsThis flag will give users the permission to create/update channels.

Allow Giphy

boolean
allowGiphyThis flag will enable the use of Giphy content in your team.

Allow users to delete messages

boolean
allowUserDeleteMessagesThis flag will give users the permission to delete messages.

Allow users to edit messages

boolean
allowUserEditMessagesThis flag will give users the permission to edit messages.

Channel Description

string
/ Required
channelDescriptionProvide a string value for the channel description.This is an example description

Channel Name

string
/ Required
channelNameProvide a string value for the channel name.myChannel

Giphy Content Rating

string
giphyContentRating

Team Description

string
/ Required
teamDescriptionProvide a string value for the description.This is an example description.

Team Name

string
/ Required
teamNameProvide a string value for the team name.myTeam

timeout

string
timeoutThe maximum time a client will await a response3000

Visibility

string
/ Required
visibilitypublicThe visibility of the group and team. Defaults to Public.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Webhook#

Create a new webhook | key: createWebhook

InputKeyNotesExample

Change Type

string
/ Required
changeTypeProvide a comma separated list of changes you want to listen for.created/updated

Expiration Date Time

string
expirationDateTimeProvide a valid date time for the expiration of the webhook.2021-10-21T14:55:45.0000000Z

Notification URL

string
/ Required
notificationUrlProvide a valid URL representing where you want the request to be directed to.https://hooks.prismatic.io/EXAMPLE

Resource

string
webhookResourceProvide a string value for the type of resource you want to listen to./teams/getAllMessages

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Member#

Get information or metadata about a team member | key: getMember

InputKeyNotesExample

Member Id

string
/ Required
memberIdProvide a string value for the member Id37635f8e-82d1-example-8ba4-af6e8985427f

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Team#

Get information or metadata about a team by Id | key: getTeam

InputKeyNotesExample

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Channel Messages#

List all of the messages in a given channel | key: listChannelMessages

InputKeyNotesExample

Channel Id

string
/ Required
channelIdProvide a string value for the channel Id37635f8e-82d1-example-8ba4-af6e8985427f

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Channels#

Retrieve the list of channels in a given team | key: listChannels

InputKeyNotesExample

Page Offset

string
skipTokenProvide an integer value for the page offset for the given object's results.3

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

Top

string
topProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Groups#

List the groups associated with your account | key: listGroups

InputKeyNotesExample

Page Offset

string
skipTokenProvide an integer value for the page offset for the given object's results.3

timeout

string
timeoutThe maximum time a client will await a response3000

Top

string
topProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


list Team Members#

List all the members in a team | key: listMembers

InputKeyNotesExample

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Teams#

List the teams associated with your account | key: listTeams

InputKeyNotesExample

Page Offset

string
skipTokenProvide an integer value for the page offset for the given object's results.3

timeout

string
timeoutThe maximum time a client will await a response3000

Top

string
topProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Remove Team Member#

Remove a user from a provided team | key: removeMember

InputKeyNotesExample

Member Id

string
/ Required
memberIdProvide a string value for the member Id37635f8e-82d1-example-8ba4-af6e8985427f

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Send Message To Channel#

Send a message to a given channel | key: sendChannelMessage

InputKeyNotesExample

Channel Id

string
/ Required
channelIdProvide a string value for the channel Id37635f8e-82d1-example-8ba4-af6e8985427f

Message

string
/ Required
messageProvide a string value for the message to send.Hello World!

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

timeout

string
timeoutThe maximum time a client will await a response3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Team#

Update an existing team | key: updateTeam

InputKeyDefaultNotesExample

Allow users to create/update channels

boolean
allowCreateUpdateChannelsThis flag will give users the permission to create/update channels.

Allow Giphy

boolean
allowGiphyThis flag will enable the use of Giphy content in your team.

Allow users to delete messages

boolean
allowUserDeleteMessagesThis flag will give users the permission to delete messages.

Allow users to edit messages

boolean
allowUserEditMessagesThis flag will give users the permission to edit messages.

Giphy Content Rating

string
giphyContentRating

Team Description

string
teamDescriptionProvide a string value for the description.This is an example description.

Team Id

string
/ Required
teamIdProvide a string value for the team Id37635f8e-82d1-example-8ba4-af6e8985427f

Team Name

string
teamNameProvide a string value for the team name.myTeam

timeout

string
timeoutThe maximum time a client will await a response3000

Visibility

string
/ Required
visibilitypublicThe visibility of the group and team. Defaults to Public.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri