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.

Microsoft Teams Connections#

OAuth 2.0 Client Credentials#

InputDefaultNotes
Input
Client ID
string
/ Required
Default
Notes
 
Input
Client secret value
password
/ Required
Default
Notes
 
Input
Scopes
string
/ Required
Hidden Field
Default
https://graph.microsoft.com/.default
Notes
Microsoft Teams permission scopes are set on the OAuth application; defaults to using `.default` to automatically use all admin consented permissions on the app
Input
Token URL
string
/ Required
Default
https://login.microsoftonline.com/common/oauth2/v2.0/token
Notes
The OAuth 2.0 Token URL for Microsoft Teams

OAuth 2.0 Authorization Code#

The Microsoft Teams component authenticates requests through the Microsoft Graph API. To configure OAuth 2.0 you must first create an application through Active Directory in the Microsoft Azure Portal.

When creating the application you will be prompted to select the 'Supported account types'. Under this section, be sure to select 'Accounts in any organizational directory (Any Azure AD directory - Multitenant)'. You will need to go to "Platforms" and add the "Web" platform. In that section you should add Prismatic's OAuth 2.0 callback URL - https://oauth2.prismatic.io/callback - as a Redirect URI.

Next, go to "Certificates & Secrets" for the app and add a new Client Secret. Note this value as you will need to supply it to the connection within Prismatic.

You will also need the Application (client) ID from the "Overview" page.

The last step of configuring the "App Registration" is assigning "App Permissions". Click "Add Permission", select all permissions that are required for your desired integration and save these values for later. A full list of scopes can be found on the Microsoft Graph API documentation

Next, supply the following values to the OAuth 2.0 connection in your integration within Prismatic:

  • For Client ID and Client Secret enter the values that you got from the Microsoft Azure Portal.
  • Provide the Scopes you assigned to your Azure application permissions.
  • If you didn't select Multitenant when creating the Azure application, you will need to replace the Authorize URL and Token URL with ones specific to your tenant.

For more information regarding authenticating against the Microsoft Graph API refer to the Microsoft documentation.

InputDefaultNotes
Input
Authorize URL
string
/ Required
Default
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Notes
The OAuth 2.0 Authorization URL for Microsoft Teams
Input
Client ID
string
/ Required
Default
Notes
 
Input
Client secret value
password
/ Required
Default
Notes
 
Input
Scopes
string
Default
https://graph.microsoft.com/Team.ReadBasic.All https://graph.microsoft.com/Team.Create https://graph.microsoft.com/Group.ReadWrite.All https://graph.microsoft.com/TeamMember.ReadWrite.All https://graph.microsoft.com/ChannelMessage.Read.All offline_access
Notes
Microsoft Teams permission scopes are set on the OAuth application
Input
Token URL
string
/ Required
Default
https://login.microsoftonline.com/common/oauth2/v2.0/token
Notes
The OAuth 2.0 Token URL for Microsoft Teams

Incoming Webhook#

Incoming Webhooks can be used for sending adaptive cards or plain text messages to individual chats or channels.

InputNotesExample
Input
Webhook URL
string
/ Required
Notes
The Incoming Webhook URL for a Teams channel.
Example
https://teamname.webhook.office.com/webhookb2/uuid/IncomingWebhook/uuid

Triggers#

Webhook#

Trigger for handling outgoing webhooks from Microsoft Teams | key: webhook

InputDefaultNotes
Input
Debug HMAC Verification
boolean
Default
Notes
 
Input
Failed Verification Trigger Response
code
Default

      {        "text": "Request Not Authorized..."      }      
Notes
 
Input
Signing Secrets
data
/ Required
Default
Notes
Can be a single secret or a list of secrets for HMAC verification
Input
Trigger Response
code
Default

      {        "text": "Request Received..."      }      
Notes
 

Output Example Payload#

{  "response": {    "statusCode": 200,    "contentType": "application/json",    "body": "{ 'text': 'test' }"  },  "payload": {    "executionId": "123123123",    "instance": { "id": "123", "name": "Example Instance" },    "invokeUrl": "https://hooks.example.com/trigger/asdfasdfasdf",    "pathFragment": "",    "headers": {      "accept": "*/*",      "Content-Type": "application/json",      "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": {      "id": "123",      "externalId": "customer-example-external-id",      "name": "John Doe"    }  }}

Data Sources#

Channel Names#

A picklist of channel names | key: channelNames | type: picklist

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f

Team Names#

A picklist of team names | key: teamNames | type: picklist

InputNotes
Input
Connection
connection
/ Required
Notes
 

Actions#

Add Team Member#

Add a new member to the team | key: addMember

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Roles
string
Value List
Notes
For each item, provide a string value containing a role you would like to assign the user.
Example
owner
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
User Id
string
/ Required
Notes
Provide a string value for the Id of the user.
Example
37635f8e-82d1-example-8ba4-af6e8985427f

Output Example Payload#

{  "data": {    "odata.type": "#microsoft.graph.aadUserConversationMember",    "id": "4e99g7eaf-68dd-43oT-ae3f",    "roles": [      "owner"    ],    "displayName": "example",    "userId": "4e99g7eaf-68dd-43oT-ae3f",    "email": "someone@example.com",    "tenantId": "4e99g7eaf-68dd-43oT-ae3f"  }}

Archive Team#

Archive the specified team | key: archiveTeam

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Create Channel#

Create a channel inside a team | key: createChannel

InputDefaultNotesExample
Input
Channel Description
string
/ Required
Default
Notes
Provide a string value for the channel description.
Example
This is an example description
Input
Channel Name
string
/ Required
Default
Notes
Provide a string value for the channel name.
Example
myChannel
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Membership Type
string
/ Required
Default
Notes
The 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.
Example
 
Input
Team
string
/ Required
Default
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Default
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
Visibility
string
/ Required
Default
public
Notes
The visibility of the group and team. Defaults to Public.
Example
 

Create Team#

Create a new team | key: createTeam

InputDefaultNotesExample
Input
Allow users to create/update channels
boolean
Default
false
Notes
This flag will give users the permission to create/update channels.
Example
 
Input
Allow Giphy
boolean
Default
false
Notes
This flag will enable the use of Giphy content in your team.
Example
 
Input
Allow users to delete messages
boolean
Default
false
Notes
This flag will give users the permission to delete messages.
Example
 
Input
Allow users to edit messages
boolean
Default
false
Notes
This flag will give users the permission to edit messages.
Example
 
Input
Channel Description
string
/ Required
Default
Notes
Provide a string value for the channel description.
Example
This is an example description
Input
Channel Name
string
/ Required
Default
Notes
Provide a string value for the channel name.
Example
myChannel
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Giphy Content Rating
string
Default
Notes
 
Example
 
Input
Team Description
string
/ Required
Default
Notes
Provide a string value for the description.
Example
This is an example description.
Input
Team Name
string
/ Required
Default
Notes
Provide a string value for the team name.
Example
myTeam
Input
Timeout
string
Default
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
Visibility
string
/ Required
Default
public
Notes
The visibility of the group and team. Defaults to Public.
Example
 

Delete Channel#

Delete the information and metadata of a given channel | key: deleteChannel

InputNotesExample
Input
Channel Id
string
/ Required
Notes
Provide a string value for the channel Id
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Delete User#

Delete the information and metadata of an existing user | key: deleteUser

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
User Id
string
/ Required
Notes
Provide a string value for the Id of the user.
Example
37635f8e-82d1-example-8ba4-af6e8985427f

Output Example Payload#

{  "data": {    "businessPhones": [      "+1 555 555 5555"    ],    "displayName": "exampleUser",    "givenName": "exampleUser",    "jobTitle": "Retail Manager",    "mail": "someoneV@example.onmicrosoft.com",    "mobilePhone": "+1 555 555 5555",    "officeLocation": "example",    "preferredLanguage": "en-US",    "surname": "Example",    "id": "3693-4789-a1c3-f4de565f"  }}

Get Channel#

Retrieve the information and metadata of a given channel | key: getChannel

InputNotesExample
Input
Channel Id
string
/ Required
Notes
Provide a string value for the channel Id
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Get Current User#

Get the information and metadata of the user that is currently logged in | key: getCurrentUser

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Output Example Payload#

{  "data": {    "businessPhones": [      "+1 555 555 5555"    ],    "displayName": "exampleUser",    "givenName": "exampleUser",    "jobTitle": "Retail Manager",    "mail": "someoneV@example.onmicrosoft.com",    "mobilePhone": "+1 555 555 5555",    "officeLocation": "example",    "preferredLanguage": "en-US",    "surname": "Example",    "id": "3693-4789-a1c3-f4de565f"  }}

Get Member#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Member
string
/ Required
Notes
Provide the identifier of a given member. This value can either be a memberId, email, userId, or displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Output Example Payload#

{  "data": {    "odata.type": "#microsoft.graph.aadUserConversationMember",    "id": "4e99g7eaf-68dd-43oT-ae3f",    "roles": [      "owner"    ],    "displayName": "example",    "userId": "4e99g7eaf-68dd-43oT-ae3f",    "email": "someone@example.com",    "tenantId": "4e99g7eaf-68dd-43oT-ae3f"  }}

Get Team#

Get information or metadata of a team | key: getTeam

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Get User#

Get the information and metadata of an existing user | key: getUser

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
User Id
string
/ Required
Notes
Provide a string value for the Id of the user.
Example
37635f8e-82d1-example-8ba4-af6e8985427f

Output Example Payload#

{  "data": {    "businessPhones": [      "+1 555 555 5555"    ],    "displayName": "exampleUser",    "givenName": "exampleUser",    "jobTitle": "Retail Manager",    "mail": "someoneV@example.onmicrosoft.com",    "mobilePhone": "+1 555 555 5555",    "officeLocation": "example",    "preferredLanguage": "en-US",    "surname": "Example",    "id": "3693-4789-a1c3-f4de565f"  }}

Install App#

Add an Installed App to given team | key: addInstalledApp

InputNotesExample
Input
App ID
string
/ Required
Notes
Provide the ID of the app to install.
Example
b1c5353a-7aca-41b3-830f-27d5218fe0e5
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

List Catalog Apps#

Retrieve the list of apps in the catalog | key: listCatalogApps

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Expand
string
Notes
Expand returned entities, uses the OData V4 query language.
Example
teamsAppDefinition
Input
Filter
string
Notes
Filters results (rows), uses the OData V4 query language.
Example
startswith(givenName,'J')
Input
Select
string
Notes
Filters properties (columns), uses the OData V4 query language.
Example
givenName,surname
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

List Channel Messages#

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

InputNotesExample
Input
Channel Id
string
/ Required
Notes
Provide a string value for the channel Id
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Filter
string
Notes
Filters results (rows), uses the OData V4 query language.
Example
startswith(givenName,'J')
Input
Order By
string
Notes
Order results (rows), uses the OData V4 query language.
Example
displayName desc
Input
Search
string
Notes
Returns results based on search criteria.
Example
Search For This
Input
Select
string
Notes
Filters properties (columns), uses the OData V4 query language.
Example
givenName,surname
Input
Page Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
Top
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20

Output Example Payload#

{  "data": {    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('id')/channels('id')/messages",    "@odata.count": "1",    "value": [      {        "id": "6525322568857",        "replyToId": "665253225688577",        "etag": "111111",        "messageType": "message",        "createdDateTime": "2022-05-13T05:26:08.857Z",        "lastModifiedDateTime": "2022-05-13T05:26:08.857Z",        "lastEditedDateTime": "2022-05-13T05:26:08.857Z",        "deletedDateTime": "2022-05-13T05:26:08.857Z",        "subject": "example",        "summary": "example",        "chatId": "",        "importance": "normal",        "locale": "en-us",        "webUrl": "https://teams.microsoft.com/l/message/example",        "eventDetail": "",        "from": {          "application": "example",          "device": "example",          "user": {            "id": "6525322568857",            "displayName": "example",            "userIdentityType": "aadUser"          },          "body": {            "contentType": "text",            "content": "Hello World"          }        }      }    ]  }}

List Channels#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Filter
string
Notes
Filters results (rows), uses the OData V4 query language.
Example
startswith(givenName,'J')
Input
Select
string
Notes
Filters properties (columns), uses the OData V4 query language.
Example
givenName,surname
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Output Example Payload#

{  "data": {    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('id')/channels",    "@odata.count": "1",    "value": [      {        "id": "19:Qm7ZZyj4FQ-TZJMWDJYIKML19X",        "createdDateTime": "2022-05-11T05:24:49.127Z",        "displayName": "General",        "isFavoriteByDefault": false,        "email": "someone@example.com",        "webUrl": "https://teams.microsoft.com/l/channel/example-id",        "membershipType": "standard"      }    ]  }}

List Installed Apps#

Retrieve the list of installed apps in a given team | key: listInstalledApps

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Expand
string
Notes
Expand returned entities, uses the OData V4 query language.
Example
teamsAppDefinition
Input
Filter
string
Notes
Filters results (rows), uses the OData V4 query language.
Example
startswith(givenName,'J')
Input
Select
string
Notes
Filters properties (columns), uses the OData V4 query language.
Example
givenName,surname
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

List Joined Teams#

List the teams you have joined | key: listJoinedTeams

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Output Example Payload#

{  "data": {    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams",    "@odata.count": 1,    "value": [      {        "id": "aa6fsa5ae-ed8e-4af1-aefs4-bce66f795ea5",        "createdDateTime": "",        "displayName": "Example Team",        "description": "Example Description",        "internalId": "aa6fsa5ae-ed8e-aefs4-bce66f795ea5",        "summary": "Example Summary"      }    ]  }}

List Team Members#

List all the members in a team | key: listMembers

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Output Example Payload#

{  "data": {    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('id')/members",    "@odata.count": 1,    "value": [      {        "odata.type": "#microsoft.graph.aadUserConversationMember",        "id": "4e99g7eaf-68dd-43oT-ae3f",        "roles": [          "owner"        ],        "displayName": "example",        "userId": "4e99g7eaf-68dd-43oT-ae3f",        "email": "someone@example.com",        "tenantId": "4e99g7eaf-68dd-43oT-ae3f"      }    ]  }}

List Teams#

List all teams | key: listTeams

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Output Example Payload#

{  "data": {    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams",    "@odata.count": 1,    "value": [      {        "id": "aa6fsa5ae-ed8e-4af1-aefs4-bce66f795ea5",        "createdDateTime": "",        "displayName": "Example Team",        "description": "Example Description",        "internalId": "aa6fsa5ae-ed8e-aefs4-bce66f795ea5",        "summary": "Example Summary"      }    ]  }}

List Teams Apps#

List apps from the Microsoft Teams app catalog | key: listTeamsApps

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Filter
string
Notes
Filters results (rows), uses the OData V4 query language.
Example
startswith(givenName,'J')
Input
Order By
string
Notes
Order results (rows), uses the OData V4 query language.
Example
displayName desc
Input
Select
string
Notes
Filters properties (columns), uses the OData V4 query language.
Example
givenName,surname
Input
Page Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
Top
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20

List User's Teams#

List all teams containing the provided user | key: listUsersTeams

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Filter
string
Notes
Filters results (rows), uses the OData V4 query language.
Example
startswith(givenName,'J')
Input
Order By
string
Notes
Order results (rows), uses the OData V4 query language.
Example
displayName desc
Input
Search
string
Notes
Returns results based on search criteria.
Example
Search For This
Input
Select
string
Notes
Filters properties (columns), uses the OData V4 query language.
Example
givenName,surname
Input
Page Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
Top
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20
Input
User Id
string
/ Required
Notes
Provide a string value for the Id of the user.
Example
37635f8e-82d1-example-8ba4-af6e8985427f

List Users#

List all users | key: listUsers

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Filter
string
Notes
Filters results (rows), uses the OData V4 query language.
Example
startswith(givenName,'J')
Input
Order By
string
Notes
Order results (rows), uses the OData V4 query language.
Example
displayName desc
Input
Search
string
Notes
Returns results based on search criteria.
Example
Search For This
Input
Select
string
Notes
Filters properties (columns), uses the OData V4 query language.
Example
givenName,surname
Input
Page Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
Top
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20

Output Example Payload#

{  "data": {    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users",    "value": [      {        "businessPhones": [          "+1 555 555 5555"        ],        "displayName": "exampleUser",        "givenName": "exampleUser",        "jobTitle": "Retail Manager",        "mail": "someoneV@example.onmicrosoft.com",        "mobilePhone": "+1 555 555 5555",        "officeLocation": "example",        "preferredLanguage": "en-US",        "surname": "Example",        "id": "3693-4789-a1c3-f4de565f"      }    ]  }}

Raw Request#

Issue a raw HTTP request | key: rawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Data
string
Default
Notes
The HTTP body payload to send to the URL.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
/ Required
Default
Notes
The HTTP method to use.
Example
 
Input
Query Parameter
string
Key Value List
Default
Notes
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Example
 
Input
Response Type
string
/ Required
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Timeout
string
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
Notes
This is the URL to call.
Example
/sobjects/Account
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Remove Installed App#

Remove an Installed App from the given team | key: removeInstalledApp

InputNotesExample
Input
App Installation ID
string
/ Required
Notes
Provide the Installation ID of the app to remove.
Example
MjljY2Q5NTctNGEzYi00ATI4LTllYmYtZjAyNWRkMTQzMmFhIyMwZTNiZWRtYS00NzIwLTQ4YjUtOWUxMy01YTFjZTEzODdkNDU=
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Remove Team Member#

Remove a user from a provided team | key: removeMember

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Member
string
/ Required
Notes
Provide the identifier of a given member. This value can either be a memberId, email, userId, or displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Send Adaptive Card To Channel#

Send an adaptive card message to a given channel | key: sendChannelAdaptiveCard

InputDefaultNotesExample
Input
Card Payload
data
/ Required
Default
Notes
Adaptive Card payload to send
Example
 
Input
Channel Id
string
/ Required
Default
Notes
Provide a string value for the channel Id
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Importance
string
Default
normal
Notes
 
Example
 
Input
Team
string
/ Required
Default
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Default
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Send Incoming Webhook Adaptive Card#

Send an adaptive card message to an Incoming Webhook | key: sendIncomingWebhookAdaptiveCard

InputNotes
Input
Card Payload
data
/ Required
Notes
Adaptive Card payload to send
Input
Connection
connection
/ Required
Notes
 

This action must use the "Incoming Webhook" connection type.

See adaptivecards.io for documentation on constructing card payloads.


Send Incoming Webhook Message#

Send a text message to an Incoming Webhook | key: sendIncomingWebhookMessage

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Message
string
/ Required
Notes
Message to send to the Incoming Webhook

This action must use the "Incoming Webhook" connection type.


Send Message To Channel#

Send a message to a given channel | key: sendChannelMessage

InputDefaultNotesExample
Input
Channel Id
string
/ Required
Default
Notes
Provide a string value for the channel Id
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Content Type
string
Default
text
Notes
Provide a value for the content type of the message
Example
 
Input
Importance
string
Default
normal
Notes
 
Example
 
Input
Message
string
/ Required
Default
Notes
Provide a string value for the message to send.
Example
Hello World!
Input
Team
string
/ Required
Default
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Default
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000

Update Channel#

Update an existing channel inside a team | key: updateChannel

InputDefaultNotesExample
Input
Channel Description
string
Default
Notes
Provide a string value for the channel description.
Example
This is an example description
Input
Channel Id
string
/ Required
Default
Notes
Provide a string value for the channel Id
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Channel Name
string
Default
Notes
Provide a string value for the channel name.
Example
myChannel
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Team
string
/ Required
Default
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Default
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
Visibility
string
Default
public
Notes
The visibility of the group and team. Defaults to Public.
Example
 

Update Team#

Update an existing team | key: updateTeam

InputDefaultNotesExample
Input
Allow users to create/update channels
boolean
Default
false
Notes
This flag will give users the permission to create/update channels.
Example
 
Input
Allow Giphy
boolean
Default
false
Notes
This flag will enable the use of Giphy content in your team.
Example
 
Input
Allow users to delete messages
boolean
Default
false
Notes
This flag will give users the permission to delete messages.
Example
 
Input
Allow users to edit messages
boolean
Default
false
Notes
This flag will give users the permission to edit messages.
Example
 
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Giphy Content Rating
string
Default
Notes
 
Example
 
Input
Team Description
string
Default
Notes
Provide a string value for the description.
Example
This is an example description.
Input
Team
string
/ Required
Default
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Team Name
string
Default
Notes
Provide a string value for the team name.
Example
myTeam
Input
Timeout
string
Default
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000
Input
Visibility
string
/ Required
Default
public
Notes
The visibility of the group and team. Defaults to Public.
Example
 

Upgrade Installed App#

Upgrade an Installed App to the latest version for given team | key: upgradeInstalledApp

InputNotesExample
Input
App Installation ID
string
/ Required
Notes
Provide the Installation ID of the app to remove.
Example
MjljY2Q5NTctNGEzYi00ATI4LTllYmYtZjAyNWRkMTQzMmFhIyMwZTNiZWRtYS00NzIwLTQ4YjUtOWUxMy01YTFjZTEzODdkNDU=
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Team
string
/ Required
Notes
Provide an identifier of the given team. This value can either be an Id or a displayName.
Example
37635f8e-82d1-example-8ba4-af6e8985427f
Input
Timeout
string
Notes
The maximum time a client will await a response in milliseconds (defaults to 30000ms)
Example
30000