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.
Connections
OAuth 2.0 Admin Consent Client Credentials
This authentication method may be used when an App requires granting admin consent to API permissions, in addition to authorizing the integration with the App's configured client credentials.
The Microsoft Teams component authenticates requests through the Microsoft Graph API.
Creating an App Registration
To configure OAuth 2.0 you must first create an App through Active Directory in the Microsoft Entra Admin Center or Microsoft Azure Portal.
- Navigate to App Registrations
- When creating the application you will be prompted to select Supported account types.
- Select Accounts in any organizational directory (Any Azure AD directory - Multitenant).
- Navigate to Redirect URI and add the Web platform. Now enter the redirect URI as
https://oauth2.prismatic.io/callbackfor US based integrations. - Select Register to complete.
- In the App, navigate to Certificates & Secrets and select New client secret. Copy/save the Value for use in the connection configuration of your integration (the value will not be shown again).
- Next, navigate to the Overview section and copy the Application (client) ID
- Navigate to the API Permissions section to assign the proper permissions for the integration. Select 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
- Recommended scopes for Teams can be found in Microsoft Graph > Application permissions:
AppCatalog.Read.AllTeamsAppInstallation.Read.GroupTeamsAppInstallation.ReadWriteSelfForTeam.AllTeamsAppInstallation.ReadWriteForTeam.AllTeamsAppInstallation.ReadWriteAndConsentForTeam.AllTeamsAppInstallation.ReadWriteAndConsentSelfForTeam.AllGroup.ReadWrite.AllDirectory.ReadWrite.AllChannelSettings.Read.GroupChannel.ReadBasic.AllChannel.Delete.GroupChannel.Create.GroupChannelSettings.ReadWrite.GroupTeamwork.Migrate.AllChannelMessage.Read.GroupGroupMember.Read.AllTeam.ReadBasic.AllTeamMember.Read.GroupTeamMember.ReadWrite.AllTeamSettings.ReadWrite.GroupTeam.CreateTeamSettings.Read.GroupUser.Read.AllUser.ReadWrite.All
- Recommended scopes for Teams can be found in Microsoft Graph > Application permissions:
For more information regarding authenticating against the Microsoft Graph API refer to the Microsoft documentation.
Configuring the Integration
Supply the following values to the OAuth 2.0 Admin Consent Client Credentials connection:
- Client ID enter the Application (client) ID
- Client Secret enter the Value provided (Do not use Secret ID)
- In the Admin Consent URL
https://login.microsoftonline.com/{tenant}/adminconsent, replace{tenant}with the Directory (tenant) ID from the App. - In the Token URL
https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token?grant_type=client_credentials, replace{tenant}with the Directory (tenant) ID from the App. - Provide the assigned API permissions as Scopes you assigned to your App. The default value will be set to
https://graph.microsoft.com/.defaultwhich will use all admin consented permissions assigned to the App. - If you didn't select Multitenant when creating the App, you will need to replace the Authorize URL and Token URL with ones specific to your tenant.
| Input | Notes | Example |
|---|---|---|
| Admin Consent URL | Replace {tenant} with the directory tenant that you want to request permission from | https://login.microsoftonline.com/{tenant}/adminconsent |
| Client ID | ||
| Client secret value | ||
| Scopes | Microsoft Teams permission scopes are set on the OAuth application; defaults to using | https://graph.microsoft.com/.default |
| Token URL | Replace {tenant} with the directory tenant that you want to request permission from | https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token?grant_type=client_credentials |
OAuth 2.0 Client Credentials
Begin by following the steps in Creating an App Registration.
When App is created, supply the following values to the OAuth 2.0 Client Credentials connection:
- Client ID enter the Application (client) ID
- Client Secret enter the Value provided (Do not use Secret ID)
- If you didn't select Multitenant when creating the App, you will need to replace the Authorize URL and Token URL with ones specific to your tenant.
| Input | Notes | Example |
|---|---|---|
| Client ID | ||
| Client secret value | ||
| Scopes | Microsoft Teams permission scopes are set on the OAuth application; defaults to using | https://graph.microsoft.com/.default |
| Token URL | The OAuth 2.0 Token URL for Microsoft Teams | https://login.microsoftonline.com/common/oauth2/v2.0/token |
OAuth 2.0 Authorization Code
Begin by following the steps in Creating an App Registration.
Recommended API permissions for Authorization Code Authentication:
- Navigate to the API Permissions section. Select Add Permission, select all permissions that are required for your desired integration. A full list of scopes can be found on the Microsoft Graph API documentation.
- Recommended scopes for Teams can be found in Microsoft Graph > Delegated permissions:
Team.ReadBasic.AllTeam.CreateTeamMember.ReadWrite.AllChannelMessage.Read.Alloffline_access
- Recommended scopes for Teams can be found in Microsoft Graph > Delegated permissions:
When an App is created, supply the following values to the OAuth 2.0 Authorization Code connection:
- Client ID enter the Application (client) ID
- Client Secret enter the Value provided (Do not use Secret ID)
- Provide the Scopes you assigned to your Azure application permissions. The default value will match the recommended scopes.
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 - Additionally, ensure the
offline_accessscope is included in your app registration. It is essential to maintain your OAuth connection and receive refresh tokens. Without it, users will need to re-authenticate every hour. - If you didn't select Multitenant when creating the App, you will need to replace the Authorize URL and Token URL with ones specific to your tenant.
| Input | Notes | Example |
|---|---|---|
| Authorize URL | The OAuth 2.0 Authorization URL for Microsoft Teams | https://login.microsoftonline.com/common/oauth2/v2.0/authorize |
| Client ID | ||
| Client secret value | ||
| Scopes | Microsoft Teams permission scopes are set on the OAuth application | 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 https://graph.microsoft.com/VirtualEvent.ReadWrite offline_access |
| Token URL | The OAuth 2.0 Token URL for Microsoft Teams | https://login.microsoftonline.com/common/oauth2/v2.0/token |
Incoming Webhook
Incoming Webhooks can be used for sending adaptive cards or plain text messages to individual chats or channels.
| Input | Notes | Example |
|---|---|---|
| Webhook URL | The Incoming Webhook URL for a Teams channel. | https://teamname.webhook.office.com/webhookb2/uuid/IncomingWebhook/uuid |
Triggers
Webhook
Receive and validate webhook requests from Microsoft Teams for webhooks you configure. | key: webhook
| Input | Notes | Example |
|---|---|---|
| Debug HMAC Verification | false | |
| Failed Verification Trigger Response | ||
| Signing Secrets | Can be a single secret or a list of secrets for HMAC verification | |
| Trigger Response |
{
"response": {
"statusCode": 200,
"contentType": "application/json",
"body": "{ 'text': 'test' }"
},
"payload": {
"user": {
"id": "123",
"name": "John Doe",
"email": "john.doe@example.com",
"externalId": "123"
},
"integration": {
"id": "123",
"name": "Example Integration",
"versionSequenceId": "123",
"externalVersion": "123"
},
"flow": {
"id": "123",
"name": "Example Flow"
},
"startedAt": "2021-01-01T00:00:00Z",
"globalDebug": false,
"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.com"
},
"body": {
"data": {}
},
"rawBody": {
"data": {
"type": "Buffer",
"data": [
69,
120,
97,
109,
112,
108,
101
]
}
},
"queryParameters": null,
"webhookUrls": {
"Flow 1": "https://hooks.example.com/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA=="
},
"webhookApiKeys": {
"Flow 1": [
"abc-123"
]
},
"customer": {
"id": "123",
"externalId": "customer-example-external-id",
"name": "John Doe"
}
}
}
Data Sources
Select Channel
A picklist of Channels. | key: channelNames | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
Select Team
A picklist of Teams. | key: teamNames | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| User Principal Name | Provide the principal name or ID of the user. Required for non-delegated App connections. | user@example.onmicrosoft.com |
Select User
A picklist of Users. | key: userNames | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Webinar
A picklist of Webinars. | key: webinarNames | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Role | Should pick either 'organizer' or 'coOrganizer' as possible values. | organizer |
Actions
Add Team Member
Add a new member to the team | key: addMember
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Roles | For each item, provide a string value containing a role you would like to assign the user. | owner |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| User Id | Provide a string value for the Id of the user. | 37635f8e-82d1-example-8ba4-af6e8985427f |
{
"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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
Cancel Webinar
Cancel a webinar | key: cancelWebinar
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Webinar ID |
{
"data": {}
}
Cancel Webinar Registration
Cancel a Registration for a given Webinar | key: cancelWebinarRegistration
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Registration ID | ||
| Webinar ID |
{
"data": {
"@odata.type": "#microsoft.graph.virtualEventRegistration",
"id": "127962bb-84e1-7b62-fd98-1c9d39def7b6",
"userId": "String",
"firstName": "Emilee",
"lastName": "Pham",
"email": "EmileeMPham@contoso.com",
"externalRegistrationInformation": {
"referrer": "Facebook",
"registrationId": "myExternalRegistrationId"
},
"status": "registered",
"registrationDateTime": "2023-03-07T22:04:17",
"cancelationDateTime": null,
"registrationQuestionAnswers": [
{
"questionId": "95320781-96b3-4b8f-8cf8-e6561d23447a",
"displayName": null,
"value": null,
"booleanValue": null,
"multiChoiceValues": [
"Seattle"
]
},
{
"questionId": "4577afdb-8bee-4219-b482-04b52c6b855c",
"displayName": null,
"value": null,
"booleanValue": true,
"multiChoiceValues": []
},
{
"questionId": "80fefcf1-caf7-4cd3-b8d7-159e17c47f20",
"displayName": null,
"value": null,
"booleanValue": null,
"multiChoiceValues": [
"Cancun",
"Hoboken",
"Beijing"
]
}
]
}
}
Create Channel
Create a channel inside a team | key: createChannel
| Input | Notes | Example |
|---|---|---|
| Channel Description | Provide a string value for the channel description. | This is an example description |
| Channel Name | Provide a string value for the channel name. | myChannel |
| Connection | ||
| Membership Type | 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. | |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Visibility | The visibility of the group and team. Defaults to Public. | public |
Create Team
Create a new team | key: createTeam
| Input | Notes | Example |
|---|---|---|
| Allow users to create/update channels | This flag will give users the permission to create/update channels. | false |
| Allow Giphy | This flag will enable the use of Giphy content in your team. | false |
| Allow users to delete messages | This flag will give users the permission to delete messages. | false |
| Allow users to edit messages | This flag will give users the permission to edit messages. | false |
| Channel Description | Provide a string value for the channel description. | This is an example description |
| Channel Name | Provide a string value for the channel name. | myChannel |
| Connection | ||
| Giphy Content Rating | ||
| Team Description | Provide a string value for the description. | This is an example description. |
| Team Name | Provide a string value for the team name. | myTeam |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Visibility | The visibility of the group and team. Defaults to Public. | public |
Create Webinar
Create a new Microsoft Teams Webinar. | key: createWebinar
| Input | Notes | Example |
|---|---|---|
| Audience | organization | |
| Connection | ||
| Co-Organizers | ||
| Description Content | The description content for the webinar. | This is a description for the webinar. |
| Description Content Type | The content type for the webinar description. | |
| Display Name | Provide a string value for the display name of the webinar. | My Webinar |
| End Date | The end date and time for the webinar. | 2025-05-28T04:00:00 |
| Attendee Email Notification Enabled | Enable or disable attendee email notifications for the webinar. | false |
| Start Date | The start date and time for the webinar. | 2025-05-28T04:00:00 |
| Time Zone | The time zone for the webinar. | Pacific Standard Time |
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#solutions/virtualEvents/webinars/$entity",
"id": "sample-id",
"audience": "everyone",
"status": "draft",
"displayName": "Test 1",
"coOrganizers": [],
"description": {
"content": "sample description",
"contentType": "html"
},
"startDateTime": {
"dateTime": "2025-06-28T04:00:00",
"timeZone": "Pacific Standard Time"
},
"endDateTime": {
"dateTime": "2025-06-28T05:00:00",
"timeZone": "Pacific Standard Time"
},
"createdBy": {
"application": null,
"device": null,
"user": {
"@odata.type": "#microsoft.graph.communicationsUserIdentity",
"id": "test-user-id",
"displayName": "Test",
"tenantId": "test-tenant-id"
}
},
"settings": {
"isAttendeeEmailNotificationEnabled": false
},
"externalEventInformation": []
}
}
Create Webinar Registration
Create a new Registration for a given Webinar | key: createWebinarRegistration
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| External Registration Information | ||
| First Name | ||
| Last Name | ||
| Preferred Language | en-us | |
| Preferred Timezone | Mountain Standard Time | |
| Registration Question Answers | ||
| Webinar ID |
{
"data": {
"@odata.type": "#microsoft.graph.virtualEventRegistration",
"id": "127962bb-84e1-7b62-fd98-1c9d39def7b6",
"userId": "String",
"firstName": "Emilee",
"lastName": "Pham",
"email": "EmileeMPham@contoso.com",
"externalRegistrationInformation": {
"referrer": "Facebook",
"registrationId": "myExternalRegistrationId"
},
"status": "registered",
"registrationDateTime": "2023-03-07T22:04:17",
"cancelationDateTime": null,
"registrationQuestionAnswers": [
{
"questionId": "95320781-96b3-4b8f-8cf8-e6561d23447a",
"displayName": null,
"value": null,
"booleanValue": null,
"multiChoiceValues": [
"Seattle"
]
},
{
"questionId": "4577afdb-8bee-4219-b482-04b52c6b855c",
"displayName": null,
"value": null,
"booleanValue": true,
"multiChoiceValues": []
},
{
"questionId": "80fefcf1-caf7-4cd3-b8d7-159e17c47f20",
"displayName": null,
"value": null,
"booleanValue": null,
"multiChoiceValues": [
"Cancun",
"Hoboken",
"Beijing"
]
}
]
}
}
Delete Channel
Delete the information and metadata of a given channel | key: deleteChannel
| Input | Notes | Example |
|---|---|---|
| Channel Id | Provide a string value for the channel Id | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Connection | ||
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
Delete User
Delete the information and metadata of an existing user | key: deleteUser
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| User Id | Provide a string value for the Id of the user. | 37635f8e-82d1-example-8ba4-af6e8985427f |
{
"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
| Input | Notes | Example |
|---|---|---|
| Channel Id | Provide a string value for the channel Id | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Connection | ||
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
Get Current Or Existing User
Get the information and metadata of the current user or an existing user | key: getCurrentUser
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| User Principal Name | Provide the principal name or ID of the user. Required for non-delegated App connections. | user@example.onmicrosoft.com |
{
"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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Member | Provide the identifier of a given member. This value should be a memberId. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
{
"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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
Get User
Get the information and metadata of an existing user | key: getUser
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| User Id | Provide a string value for the Id of the user. | 37635f8e-82d1-example-8ba4-af6e8985427f |
{
"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 Webinar
Get a webinar | key: getWebinar
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Webinar ID |
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.virtualEventWebinar",
"id": "88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33",
"status": "published",
"displayName": "The Impact of Tech on Our Lives",
"description": {
"contentType": "text",
"content": "Discusses how technology has changed the way we communicate, work, and interact with each other."
},
"startDateTime": {
"dateTime": "2023-03-30T10:00:00",
"timeZone": "Pacific Standard Time"
},
"endDateTime": {
"dateTime": "2023-03-30T17:00:00",
"timeZone": "Pacific Standard Time"
},
"createdBy": {
"application": null,
"device": null,
"user": {
"@odata.type": "#microsoft.graph.communicationsUserIdentity",
"id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68",
"displayName": "Diane Demoss",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
},
"audience": "everyone",
"coOrganizers": [
{
"id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
"displayName": "Kenneth Brown",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
],
"settings": {
"isAttendeeEmailNotificationEnabled": false
},
"externalEventInformation": [
{
"applicationId": "67a527ba-ef0e-4ba2-88b6-4fa5e9711757",
"externalEventId": "myExternalEventId"
}
]
}
]
}
}
Get Webinar Registration
Get a Registration for a given Webinar | key: getWebinarRegistration
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Registration ID | ||
| Webinar ID |
{
"data": {
"@odata.type": "#microsoft.graph.virtualEventRegistration",
"id": "127962bb-84e1-7b62-fd98-1c9d39def7b6",
"userId": "String",
"firstName": "Emilee",
"lastName": "Pham",
"email": "EmileeMPham@contoso.com",
"externalRegistrationInformation": {
"referrer": "Facebook",
"registrationId": "myExternalRegistrationId"
},
"status": "registered",
"registrationDateTime": "2023-03-07T22:04:17",
"cancelationDateTime": null,
"registrationQuestionAnswers": [
{
"questionId": "95320781-96b3-4b8f-8cf8-e6561d23447a",
"displayName": null,
"value": null,
"booleanValue": null,
"multiChoiceValues": [
"Seattle"
]
},
{
"questionId": "4577afdb-8bee-4219-b482-04b52c6b855c",
"displayName": null,
"value": null,
"booleanValue": true,
"multiChoiceValues": []
},
{
"questionId": "80fefcf1-caf7-4cd3-b8d7-159e17c47f20",
"displayName": null,
"value": null,
"booleanValue": null,
"multiChoiceValues": [
"Cancun",
"Hoboken",
"Beijing"
]
}
]
}
}
Get Webinar Session
Get a webinar | key: getWebinarSession
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Session ID | ||
| Webinar ID |
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.virtualEventWebinar",
"id": "88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33",
"status": "published",
"displayName": "The Impact of Tech on Our Lives",
"description": {
"contentType": "text",
"content": "Discusses how technology has changed the way we communicate, work, and interact with each other."
},
"startDateTime": {
"dateTime": "2023-03-30T10:00:00",
"timeZone": "Pacific Standard Time"
},
"endDateTime": {
"dateTime": "2023-03-30T17:00:00",
"timeZone": "Pacific Standard Time"
},
"createdBy": {
"application": null,
"device": null,
"user": {
"@odata.type": "#microsoft.graph.communicationsUserIdentity",
"id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68",
"displayName": "Diane Demoss",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
},
"audience": "everyone",
"coOrganizers": [
{
"id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
"displayName": "Kenneth Brown",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
],
"settings": {
"isAttendeeEmailNotificationEnabled": false
},
"externalEventInformation": [
{
"applicationId": "67a527ba-ef0e-4ba2-88b6-4fa5e9711757",
"externalEventId": "myExternalEventId"
}
]
}
]
}
}
Get Webinar Session Attendance Report
Get a Session Attendance Report for a given Webinar | key: getSessionAttendanceReport
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand returned entities, uses the OData V4 query language. | teamsAppDefinition |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Order By | Order results (rows), uses the OData V4 query language. | displayName desc |
| Report ID | ||
| Search | Returns results based on search criteria. | Search For This |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Session ID | ||
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
| Webinar ID |
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.virtualEventWebinar",
"id": "88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33",
"status": "published",
"displayName": "The Impact of Tech on Our Lives",
"description": {
"contentType": "text",
"content": "Discusses how technology has changed the way we communicate, work, and interact with each other."
},
"startDateTime": {
"dateTime": "2023-03-30T10:00:00",
"timeZone": "Pacific Standard Time"
},
"endDateTime": {
"dateTime": "2023-03-30T17:00:00",
"timeZone": "Pacific Standard Time"
},
"createdBy": {
"application": null,
"device": null,
"user": {
"@odata.type": "#microsoft.graph.communicationsUserIdentity",
"id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68",
"displayName": "Diane Demoss",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
},
"audience": "everyone",
"coOrganizers": [
{
"id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
"displayName": "Kenneth Brown",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
],
"settings": {
"isAttendeeEmailNotificationEnabled": false
},
"externalEventInformation": [
{
"applicationId": "67a527ba-ef0e-4ba2-88b6-4fa5e9711757",
"externalEventId": "myExternalEventId"
}
]
}
]
}
}
Install App
Add an Installed App to given team | key: addInstalledApp
| Input | Notes | Example |
|---|---|---|
| App ID | Provide the ID of the app to install. | b1c5353a-7aca-41b3-830f-27d5218fe0e5 |
| Connection | ||
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
List Attendance Records
List all Attendance Records for a given Attendance Report | key: listAttendanceRecords
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand returned entities, uses the OData V4 query language. | teamsAppDefinition |
| Fetch All | Set to true to retrieve all results. | false |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Order By | Order results (rows), uses the OData V4 query language. | displayName desc |
| Report ID | ||
| Search | Returns results based on search criteria. | Search For This |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Session ID | ||
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
| Webinar ID |
{
"data": {
"@odata.context": "https://graph.microsoft.com/beta/$metadata#solutions/virtualEvents/webinars('f8ce2a5f-0e6a-4186-aa90-1f64bc023566@5466a424-aadf-425c-9b24-034ca28d4bdd')/sessions('8d62dd52-4dff-4c75-96a9-f905cc3ff942')/attendanceReports('b76965d4-0763-496e-9980-b323c5f3aa3b')/attendancerecords",
"value": [
{
"emailAddress": "frederick.cormier@contoso.com",
"totalAttendanceInSeconds": 322,
"role": "Organizer",
"registrantId": null,
"identity": {
"id": "dc17674c-81d9-4adb-bfb2-8f6a442e4623",
"displayName": "Frederick Cormier",
"tenantId": null
},
"attendanceIntervals": [
{
"joinDateTime": "2021-10-05T04:38:27.6027225Z",
"leaveDateTime": "2021-10-05T04:43:49.7702391Z",
"durationInSeconds": 322
}
]
},
{
"emailAddress": "lisa.adkins@contoso.com",
"totalAttendanceInSeconds": 314,
"role": "Presenter",
"registrantId": null,
"identity": {
"id": "57caaef9-5ed0-48d5-8862-e5abfa71b3e9",
"displayName": "Lisa Adkins",
"tenantId": null
},
"attendanceIntervals": [
{
"joinDateTime": "2021-10-04T23:13:43.3776519Z",
"leaveDateTime": "2021-10-04T23:18:57.5639338Z",
"durationInSeconds": 314
}
]
}
]
}
}
List Catalog Apps
Retrieve the list of apps in the catalog | key: listCatalogApps
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand returned entities, uses the OData V4 query language. | teamsAppDefinition |
| Fetch All | Set to true to retrieve all results. | false |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
List Channel Messages
List all of the messages in a given channel | key: listChannelMessages
| Input | Notes | Example |
|---|---|---|
| Channel Id | Provide a string value for the channel Id | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Connection | ||
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Order By | Order results (rows), uses the OData V4 query language. | displayName desc |
| Search | Returns results based on search criteria. | Search For This |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
{
"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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fetch All | Set to true to retrieve all results. | false |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
{
"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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand returned entities, uses the OData V4 query language. | teamsAppDefinition |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
List Joined Teams
List the teams you have joined | key: listJoinedTeams
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fetch All | Set to true to retrieve all results. | false |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
| User Principal Name | Provide the principal name or ID of the user. Required for non-delegated App connections. | user@example.onmicrosoft.com |
{
"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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fetch All | Set to true to retrieve all results. | false |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
{
"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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fetch All | Set to true to retrieve all results. | false |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Order By | Order results (rows), uses the OData V4 query language. | displayName desc |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
{
"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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Order By | Order results (rows), uses the OData V4 query language. | displayName desc |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
List User's Teams
List all teams containing the provided user | key: listUsersTeams
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fetch All | Set to true to retrieve all results. | false |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Order By | Order results (rows), uses the OData V4 query language. | displayName desc |
| Search | Returns results based on search criteria. | Search For This |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
| User Id | Provide a string value for the Id of the user. | 37635f8e-82d1-example-8ba4-af6e8985427f |
List Users
List all users | key: listUsers
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fetch All | Set to true to retrieve all results. | false |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Order By | Order results (rows), uses the OData V4 query language. | displayName desc |
| Search | Returns results based on search criteria. | Search For This |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
{
"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"
}
]
}
}
List Webinar Registrations
List all Registrations for a given Webinar | key: listWebinarRegistrations
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Webinar ID |
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.virtualEventRegistration",
"id": "127962bb-84e1-7b62-fd98-1c9d39def7b6",
"userId": "String",
"firstName": "Emilee",
"lastName": "Pham",
"email": "EmileeMPham@contoso.com",
"externalRegistrationInformation": {
"referrer": "Facebook",
"registrationId": "myExternalRegistrationId"
},
"status": "registered",
"registrationDateTime": "2023-03-07T22:04:17",
"cancelationDateTime": null,
"registrationQuestionAnswers": [
{
"questionId": "95320781-96b3-4b8f-8cf8-e6561d23447a",
"displayName": null,
"value": null,
"booleanValue": null,
"multiChoiceValues": [
"Seattle"
]
},
{
"questionId": "4577afdb-8bee-4219-b482-04b52c6b855c",
"displayName": null,
"value": null,
"booleanValue": true,
"multiChoiceValues": []
},
{
"questionId": "80fefcf1-caf7-4cd3-b8d7-159e17c47f20",
"displayName": null,
"value": null,
"booleanValue": null,
"multiChoiceValues": [
"Cancun",
"Hoboken",
"Beijing"
]
}
]
}
]
}
}
List Webinar Session Attendance Reports
List all Session Attendance Reports for a given Webinar | key: listSessionAttendanceReports
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fetch All | Set to true to retrieve all results. | false |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Order By | Order results (rows), uses the OData V4 query language. | displayName desc |
| Search | Returns results based on search criteria. | Search For This |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Session ID | ||
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
| Webinar ID |
{
"data": {
"@odata.context": "https://graph.microsoft.com/beta/$metadata#solutions/virtualEvents/webinars('f8ce2a5f-0e6a-4186-aa90-1f64bc023566@5466a424-aadf-425c-9b24-034ca28d4bdd')/sessions('8d62dd52-4dff-4c75-96a9-f905cc3ff942')/attendanceReports",
"value": [
{
"@odata.type": "#microsoft.graph.virtualEventWebinar",
"id": "88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33",
"status": "published",
"displayName": "The Impact of Tech on Our Lives",
"description": {
"contentType": "text",
"content": "Discusses how technology has changed the way we communicate, work, and interact with each other."
},
"startDateTime": {
"dateTime": "2023-03-30T10:00:00",
"timeZone": "Pacific Standard Time"
},
"endDateTime": {
"dateTime": "2023-03-30T17:00:00",
"timeZone": "Pacific Standard Time"
},
"createdBy": {
"application": null,
"device": null,
"user": {
"@odata.type": "#microsoft.graph.communicationsUserIdentity",
"id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68",
"displayName": "Diane Demoss",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
},
"audience": "everyone",
"coOrganizers": [
{
"id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
"displayName": "Kenneth Brown",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
],
"settings": {
"isAttendeeEmailNotificationEnabled": false
},
"externalEventInformation": [
{
"applicationId": "67a527ba-ef0e-4ba2-88b6-4fa5e9711757",
"externalEventId": "myExternalEventId"
}
]
}
]
}
}
List Webinar Sessions
List all Sessions for a given Webinar | key: listWebinarSessions
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand returned entities, uses the OData V4 query language. | teamsAppDefinition |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Order By | Order results (rows), uses the OData V4 query language. | displayName desc |
| Search | Returns results based on search criteria. | Search For This |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
| Webinar ID |
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.virtualEventSession",
"id": "8d62dd52-4dff-4c75-96a9-f905cc3ff942",
"startDateTime": "2023-08-08T12:30:00Z",
"endDateTime": "2023-08-09T22:00:00Z",
"joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_ZDVjNzk3OWEtYjc2NS00NTA1LTkyMzQtYTYzMGI5YmFmMjM5%40thread.v2/0?context=%7b%22Tid%22%3a%2272f988bf-86f1-41af-91ab-2d7cd011db47%22%2c%22Oid%22%3a%221cd068e4-5b08-4e75-a7f9-7b4e067a0820%22%7d",
"subject": "Session one",
"isBroadcast": null,
"broadcastSettings": null,
"capabilities": [],
"audioConferencing": null,
"chatInfo": null,
"videoTeleconferenceId": null,
"externalId": null,
"joinMeetingIdSettings": null,
"lobbyBypassSettings": null,
"isEntryExitAnnounced": null,
"allowedPresenters": null,
"allowAttendeeToEnableMic": null,
"allowAttendeeToEnableCamera": null,
"allowMeetingChat": null,
"shareMeetingChatHistoryDefault": null,
"allowTeamworkReactions": null,
"recordAutomatically": null,
"watermarkProtection": null,
"allowParticipantsToChangeName": null
}
]
}
}
List Webinars
List all webinars | key: listWebinars
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand returned entities, uses the OData V4 query language. | teamsAppDefinition |
| Filter | Filters results (rows), uses the OData V4 query language. | startswith(givenName,'J') |
| Order By | Order results (rows), uses the OData V4 query language. | displayName desc |
| Role | ||
| Search | Returns results based on search criteria. | Search For This |
| Select | Filters properties (columns), uses the OData V4 query language. | givenName,surname |
| Page Offset | Provide an integer value for the page offset for the given object's results. | 3 |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Top | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 100. | 20 |
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.virtualEventWebinar",
"id": "88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33",
"status": "published",
"displayName": "The Impact of Tech on Our Lives",
"description": {
"contentType": "text",
"content": "Discusses how technology has changed the way we communicate, work, and interact with each other."
},
"startDateTime": {
"dateTime": "2023-03-30T10:00:00",
"timeZone": "Pacific Standard Time"
},
"endDateTime": {
"dateTime": "2023-03-30T17:00:00",
"timeZone": "Pacific Standard Time"
},
"createdBy": {
"application": null,
"device": null,
"user": {
"@odata.type": "#microsoft.graph.communicationsUserIdentity",
"id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68",
"displayName": "Diane Demoss",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
},
"audience": "everyone",
"coOrganizers": [
{
"id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
"displayName": "Kenneth Brown",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
],
"settings": {
"isAttendeeEmailNotificationEnabled": false
},
"externalEventInformation": [
{
"applicationId": "67a527ba-ef0e-4ba2-88b6-4fa5e9711757",
"externalEventId": "myExternalEventId"
}
]
}
]
}
}
Publish Webinar
Publish a webinar | key: publishWebinar
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Webinar ID |
{
"data": {}
}
Raw Request
Send raw HTTP request to Microsoft Teams | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | 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. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/users), The base URL is already included (https://graph.microsoft.com/v1.0). For example, to connect to https://graph.microsoft.com/v1.0/users, only /users is entered in this field. | /users |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Remove Installed App
Remove an Installed App from the given team | key: removeInstalledApp
| Input | Notes | Example |
|---|---|---|
| App Installation ID | Provide the Installation ID of the app to remove. | MjljY2Q5NTctNGEzYi00ATI4LTllYmYtZjAyNWRkMTQzMmFhIyMwZTNiZWRtYS00NzIwLTQ4YjUtOWUxMy01YTFjZTEzODdkNDU= |
| Connection | ||
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
Remove Team Member
Remove a user from a provided team | key: removeMember
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Member | Provide the identifier of a given member. This value should be a memberId. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
Send Adaptive Card To Channel
Send an adaptive card message to a given channel | key: sendChannelAdaptiveCard
| Input | Notes | Example |
|---|---|---|
| Card Payload | Adaptive Card payload to send | |
| Channel Id | Provide a string value for the channel Id | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Connection | ||
| Importance | normal | |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
Send Incoming Webhook Adaptive Card
Send an adaptive card message to an Incoming Webhook | key: sendIncomingWebhookAdaptiveCard
| Input | Notes | Example |
|---|---|---|
| Card Payload | Adaptive Card payload to send | |
| Connection |
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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Message | 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
| Input | Notes | Example |
|---|---|---|
| Channel Id | Provide a string value for the channel Id | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Connection | ||
| Content Type | Provide a value for the content type of the message | text |
| Importance | normal | |
| Message | Provide a string value for the message to send. | Hello World! |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
Update Channel
Update an existing channel inside a team | key: updateChannel
| Input | Notes | Example |
|---|---|---|
| Channel Description | Provide a string value for the channel description. | This is an example description |
| Channel Id | Provide a string value for the channel Id | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Channel Name | Provide a string value for the channel name. | myChannel |
| Connection | ||
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Visibility | The visibility of the group and team. Defaults to Public. | public |
Update Team
Update an existing team | key: updateTeam
| Input | Notes | Example |
|---|---|---|
| Allow users to create/update channels | This flag will give users the permission to create/update channels. | false |
| Allow Giphy | This flag will enable the use of Giphy content in your team. | false |
| Allow users to delete messages | This flag will give users the permission to delete messages. | false |
| Allow users to edit messages | This flag will give users the permission to edit messages. | false |
| Connection | ||
| Giphy Content Rating | ||
| Team Description | Provide a string value for the description. | This is an example description. |
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Team Name | Provide a string value for the team name. | myTeam |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
| Visibility | The visibility of the group and team. Defaults to Public. | public |
Upgrade Installed App
Upgrade an Installed App to the latest version for given team | key: upgradeInstalledApp
| Input | Notes | Example |
|---|---|---|
| App Installation ID | Provide the Installation ID of the app to remove. | MjljY2Q5NTctNGEzYi00ATI4LTllYmYtZjAyNWRkMTQzMmFhIyMwZTNiZWRtYS00NzIwLTQ4YjUtOWUxMy01YTFjZTEzODdkNDU= |
| Connection | ||
| Team | Provide an identifier of the given team. This value should be an Id. | 37635f8e-82d1-example-8ba4-af6e8985427f |
| Timeout | The maximum time a client will await a response in milliseconds (defaults to 30000ms) | 30000 |
Changelog
2025-06-06
Added Create Webinar action, modernized component structure, and added global debug with inline datasources for enhanced functionality