Microsoft Teams connector
The Microsoft Teams connector connects Kibana to Microsoft Teams through the Microsoft Graph API. Agents and workflows can use it to send messages, search conversations, and browse teams, channels, and chats.
You can use this connector in Agent Builder and Workflows.
Some capabilities of this connector are only available from a certain version:
-
Quick Connect OAuth 2.0. -
Send, update, and create actions to post channel and chat messages, edit a message, look up a user, and create a chat. -
Workflow events from Microsoft Graph change notifications.
In Microsoft Entra ID, you need an app registration for bearer token, OAuth authorization code, or OAuth client credentials. Quick Connect does not need an app registration.
Registering the app and granting admin consent requires a role that can do both, such as Cloud Application Administrator. Application Developer can register the app and cannot grant admin consent. Teams Administrator cannot register an app.
In Kibana, you need:
- The Actions and Connectors : All privilege, to create and edit connectors.
-
An Enterprise license and server.publicBaseUrlset to the host that Microsoft Graph uses to reach Kibana, to receive events.xpack.actions.inboundEvents.enableddefaults totrue. Set it tofalseto turn receive events off. Graph must be able to reach a public HTTPS URL. Graph cannot calllocalhost.
To use the connector, set up credentials in Microsoft Entra ID (or use Quick Connect), create the connector in Kibana, and test it.
No setup required. Select Quick Connect OAuth 2.0 when creating the connector in Kibana and follow the authorization prompt to grant Elastic access to your Microsoft Teams workspace.
- Sign in to the Azure portal. Select Azure Active Directory → App registrations.
- Create a new application registration.
- Under API permissions, add the following Delegated permissions for Microsoft Graph:
Team.ReadBasic.All— List joined teams and channelsChat.Read— Read chat messagesChannelMessage.Read.All— Read channel messagesChat.ReadBasic— List chatsChannelMessage.Send— Send channel messages (required forsendChannelMessage)Chat.ReadWrite— Send and create chats (required forsendChatMessageandcreateChat)
- Obtain a user access token through the OAuth delegated flow (for example, Authorization Code flow).
- In the Microsoft API token field, enter your user access token.
Sign in to the Azure portal. Select Azure Active Directory → App registrations.
Create a new application registration.
Under Authentication, select Add a platform, choose Web, and enter your Kibana redirect URI. Copy the following pattern and replace your public Kibana hostname. Azure accepts
http://localhostfor a local Kibana:https://<your-kibana-host>/api/actions/connector/_oauth_callbackUnder API permissions, add the following Delegated permissions for Microsoft Graph:
Team.ReadBasic.All— List joined teamsChannel.ReadBasic.All— List channelsChat.Read— Read chat messagesChannelMessage.Read.All— Read channel messagesoffline_access— Maintain access through refresh tokensChannelMessage.Send— Send channel messages (required forsendChannelMessage)Chat.ReadWrite— Send and create chats (required forsendChatMessageandcreateChat)
Copy the Application (client) ID and your tenant ID from the app registration Overview page.
Under Certificates & secrets, create a new client secret and copy the value.
In the connector configuration, enter:
- Authorization URL:
https://login.microsoftonline.com/{your-tenant-id}/oauth2/v2.0/authorize - Token URL:
https://login.microsoftonline.com/{your-tenant-id}/oauth2/v2.0/token - Client ID: your Application (client) ID
- Client Secret: the secret value from step 6
- Authorization URL:
After you add a permission, sign in to the connector again so the stored token includes it. On edit, Kibana asks you to re-enter encrypted fields such as the client secret.
- Sign in to the Azure portal. Select Azure Active Directory → App registrations.
- Create a new application registration.
- Under API permissions, add the following Application permissions for Microsoft Graph:
Team.ReadBasic.All— List all teams in the tenantChannel.ReadBasic.All— List channelsChannelMessage.Read.All— Read channel messagesChat.Read.All— Read all chats and messagesChannelMessage.ReadWrite.All— Send and update channel messages (required forsendChannelMessageandupdateMessage)Chat.ReadWrite.All— Send, create, and update chats (required forsendChatMessageandcreateChat)
- Select Grant admin consent. The permission row must say Granted. A permission that was only added is not in the token.
- Under Certificates & secrets, create a new client secret.
- Copy the Application (client) ID, client secret value, and tenant ID. In the connector configuration, enter these values.
Use this method when you want to authenticate without a client secret, using a certificate registered with your Azure AD app. This corresponds to the oauth_client_credentials_private_key_jwt auth type in the connector.
- Sign in to the Azure portal. Select Azure Active Directory → App registrations.
- Create a new application registration (or reuse an existing one).
- Under API permissions, add the same Application permissions as the OAuth client credentials method above.
- Select Grant admin consent. The permission row must say Granted.
- Generate a certificate and private key pair (for example, using OpenSSL):
openssl req -x509 -newkey rsa:4096 -keyout private_key.pem -out certificate.pem -days 365 -nodes - Under Certificates & secrets → Certificates, upload the
certificate.pempublic certificate file. - In the connector configuration, enter:
- Token URL:
https://login.microsoftonline.com/{your-tenant-id}/oauth2/v2.0/token - Client ID: your Application (client) ID
- Private Key: the contents of
private_key.pem - Certificate: the contents of
certificate.pem(used to compute thex5t#S256thumbprint sent in the JWT assertion)
- Token URL:
You can create connectors in Stack Management → Connectors.
Microsoft Teams connectors support Quick Connect OAuth 2.0, a bearer token, OAuth authorization code, and OAuth client credentials. Select the authentication type when you create or edit the connector.
Elastic's managed OAuth flow for Microsoft Teams. No app setup is required. Select this option and authorize access to your Microsoft Teams workspace through Elastic. Provides delegated access (the connector acts as the authenticated user) with the same permissions as the OAuth authorization code method. Your Microsoft 365 administrator might need to grant consent for the Elastic app. Refer to Quick Connect OAuth 2.0.
- Microsoft API token
- A Microsoft bearer token obtained through the delegated OAuth flow (for example, a user access token). Provides access to the authenticated user's teams, channels, chats, and messages.
- Authorization URL
- The Microsoft Entra ID authorization endpoint. Use the format:
https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize. Replace{tenant-id}with your Azure AD tenant ID. - Token URL
- The Microsoft Entra ID token endpoint. Use the format:
https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/token. Replace{tenant-id}with your Azure AD tenant ID.
- Client ID
- The Application (client) ID of your Azure Active Directory (Azure AD) application registration.
- Client secret
- The client secret generated for your Azure AD application.
- Tenant ID
- Your Azure AD tenant ID. Used to construct the token endpoint:
https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token.
Use the Action configuration settings to customize connector networking, such as proxies, certificates, or TLS settings. If you use xpack.actions.allowedHosts, add graph.microsoft.com and login.microsoftonline.com to the list.
You can test connectors while creating or editing them in Kibana. The test verifies connectivity by listing the authenticated user's joined teams when using delegated auth, or all teams in the tenant when using app-only auth.
The Microsoft Teams connector has the following actions.
- List joined teams
-
Returns the authenticated user's joined teams when using delegated auth, or the specified user's joined teams when
userIdis provided for app-only auth.userId(optional): User ID for app-only auth through client credentials. Omit when using delegated auth (Quick Connect OAuth 2.0, bearer token, or OAuth authorization code).
- List channels
-
Returns channels for the specified team.
teamId(required): The ID of the team.
- List channel messages
-
Returns messages in a channel. The action returns the newest root messages, up to 50, not one message by id. A reply is not in that page.
teamId(required): The ID of the team.channelId(required): The ID of the channel.top(optional): Number of messages to return, up to 50.
- List chats
-
Returns chats for the authenticated user.
userId(optional): User ID for app-only auth through client credentials. Omit when using delegated auth (Quick Connect OAuth 2.0, bearer token, or OAuth authorization code).top(optional): Number of chats to return, up to 50.
- List chat messages
-
Returns messages in a chat. The action returns the newest messages, up to 50, not one message by id. It reads chats the signed-in user belongs to.
chatId(required): The ID of the chat.top(optional): Number of messages to return, up to 50.
- Search messages
-
Searches for messages across Teams and chats using the Microsoft Graph Search API. It supports Keyword Query Language (KQL) syntax. Requires delegated authentication (Quick Connect OAuth 2.0, bearer token, or OAuth authorization code). Not supported with app-only (client credentials) auth.
query(required): Search query string (for example,from:alice sent>2024-01-01).from(optional): Offset for pagination.size(optional): Number of results to return, up to 25.enableTopResults(optional): Sort results by relevance.
- Send channel message
-
Posts a new message to a channel. Requires the
ChannelMessage.Senddelegated permission orChannelMessage.ReadWrite.Allapplication permission.teamId(required): The ID of the team containing the channel.channelId(required): The ID of the channel to post to.content(required): The message body text (plain text or HTML, up to 10,000 characters).contentType(optional):"text"(default) or"html".subject(optional): Optional subject line displayed as a message header.
- Send chat message
-
Posts a new message to an existing chat (1:1 or group). Requires the
Chat.ReadWritedelegated permission orChat.ReadWrite.Allapplication permission.chatId(required): The ID of the chat to send the message to.content(required): The message body text (plain text or HTML, up to 10,000 characters).contentType(optional):"text"(default) or"html".
- Update message
-
Edits the body of an existing channel or chat message. Provide
teamIdandchannelIdfor a channel message, orchatIdfor a chat message.messageId(required): The ID of the message to update.teamId(optional, channel messages): The team ID. Must be provided together withchannelId.channelId(optional, channel messages): The channel ID. Must be provided together withteamId.chatId(optional, chat messages): The chat ID. Mutually exclusive withteamIdandchannelId.content(required): The new message body text.contentType(optional):"text"(default) or"html".
- Get user
-
Looks up a user by ID (GUID) or user principal name (UPN, for example
alice@contoso.com). Useful for resolving an email address to a GUID before callingcreateChat.userId(required): The user ID (GUID) or UPN to look up.
- Create chat
-
Creates a new 1:1 or group chat and returns the resulting chat object including its
id. Requires theChat.ReadWritedelegated permission orChat.ReadWrite.Allapplication permission.chatType(required):"oneOnOne"for a 1:1 direct message (exactly two member IDs: yourself and the other person) or"group"for a group chat (yourself plus two or more others).memberIds(required): Array of user IDs (GUIDs or UPNs) of all chat members, including yourself (2–20 members).topic(optional): Display topic or title for group chats. Ignored for"oneOnOne"chats.
The connector can start a workflow from a Microsoft Graph change notification. A saved connector does not receive events until Receive events is turned on for that connector. After you save a new connector, Kibana shows the Webhook URL and the ingest token once, so copy them then. For an existing connector, save it, then select Rotate ingest token. A new token stops the previous one from working. Update the subscription URL after you rotate. Turning Receive events off and saving stops the webhook URL immediately. Workflows bound to this connector stop getting events. Outbound actions keep working.
This toggle appears when xpack.actions.inboundEvents.enabled is true. Kibana does not create or renew the Graph subscription. To send events from Microsoft Graph, refer to Start a workflow from Microsoft Teams events.
The ingest token authenticates the webhook request. The workflow runs with the identity of the last user who saved the connector. The token is separate from the connector's outbound credentials.
The connector supports five events. A workflow subscribes to an event by using its ID as the trigger type.
| Workflow event | When it runs | Fields |
|---|---|---|
microsoft-teams.channel_message |
A message is posted in a channel | team_id, channel_id, message_id, optional tenant_id |
microsoft-teams.chat_message |
A message is posted in a chat | chat_id, message_id, optional tenant_id |
microsoft-teams.channel_created |
A channel is created | team_id, channel_id, optional tenant_id |
microsoft-teams.chat_created |
A chat is created | chat_id, optional tenant_id |
microsoft-teams.team_member_added |
A user is added to a team | team_id, user_id, optional tenant_id |
tenant_id is present when Graph sends tenantId. On a team member event, user_id is resourceData.userId when Graph sends it. A basic notification omits that field. The membership id is base64 of {team-id}##{user-id} or 0##{tenant-id}##{user-id}, and Kibana reads the user id from that value. Adding a member to a channel does not start this event. A reply in a channel uses microsoft-teams.channel_message. message_id is the reply id, from the replies segment of the resource path.
Only created starts one of these workflows. Edits, deletes, chat members, and channel members do not. A notification that matches none of these events does not start a workflow. Kibana reads the ids from the resource path and resourceData. encryptedContent, when Graph includes it, is ignored. The event does not include the message body, content type, or sender.
One Graph request can start at most xpack.actions.inboundEvents.maxEmitted workflows. The default is 25 and the maximum is 250. Kibana rejects a larger batch and starts no workflow from it. The HTTP response is 500, with the body Unable to process inbound connector event request. That same response is used for other processing failures, so HTTP 500 alone does not mean the batch was too large. Microsoft Graph retries the request. A subscription to one team, channel, or chat usually stays under the default. For a tenant-wide resource such as /teams/getAllMessages or /chats/getAllMessages, set the value in kibana.yml to the largest batch you expect, up to 250:
xpack.actions.inboundEvents.maxEmitted: 100
Microsoft Graph sends each notification to the webhook URL of the connector. The Webhook URL field does not include the ingest token. Graph does not send an Authorization header, so append the token yourself. Use that full URL for both notificationUrl and lifecycleNotificationUrl.
The URL has one of these shapes. The default space has no /s/<space-id> prefix.
https://<kibana-host>/api/actions/events/.microsoft-teams/<connector-id>?token=<ingest-token>
https://<kibana-host>/s/<space-id>/api/actions/events/.microsoft-teams/<connector-id>?token=<ingest-token>
To run a Kibana workflow when a channel message, chat message, channel, chat, or team member is created in Microsoft Teams, create a Graph subscription and point it at the webhook URL. Kibana does not create the subscription for you.
Before you start, meet the requirements in Receive Microsoft Teams events and turn on Receive events on the connector. Create the subscription after the connector is saved. A post that was sent before the subscription existed is not delivered.
- Team id
- In Teams, open the channel and select Get link to channel.
groupIdin that link is the team id. It is a GUID (8-4-4-4-12). You can also callGET https://graph.microsoft.com/v1.0/me/joinedTeamsand readid. - Channel id
- In the same link, decode the segment after
/channel/. Replace%3awith:and%40with@, so19%3aabc%40thread.tacv2becomes19:abc@thread.tacv2. For the General channel,GET https://graph.microsoft.com/v1.0/teams/{team-id}returns that id ininternalId.GET https://graph.microsoft.com/v1.0/teams/{team-id}/channelslists every channel. - Chat id
- Call
GET https://graph.microsoft.com/v1.0/me/chatswith the user who will own the subscription. An emptyvaluearray means that user has not opened a chat yet. Start a chat in Teams, send one message, and call it again. Copy theidthat starts with19:. - User id
- Call
GET https://graph.microsoft.com/v1.0/meand copyid. Use it inusers/{user-id}/chats.
Create the subscription with POST https://graph.microsoft.com/v1.0/subscriptions. Set changeType to created. Set notificationUrl and lifecycleNotificationUrl to the webhook URL including ?token=. Set expirationDateTime at most 4,320 minutes (3 days) ahead. An expiration more than 1 hour ahead requires lifecycleNotificationUrl. Renew the subscription in Graph before subscriptionExpirationDateTime. Kibana does not renew it.
clientState is optional and at most 128 characters. Set it to a secret. Graph sends that value back on each notification. Kibana does not read it.
A subscription to one team, channel, chat, or user can be created in Graph Explorer while you are signed in as a member of that team. Modify permissions lists only the permissions for the request currently in the address bar. Point the request at the resource you are subscribing to, consent to the delegated permission in the table below, then change the method to POST https://graph.microsoft.com/v1.0/subscriptions and paste the body. GET https://graph.microsoft.com/v1.0/subscriptions lists subscriptions for that signed-in user. Another account receives ResourceNotFound.
A tenant-wide resource (/teams/getAllMessages, /teams/getAllChannels, /chats, /chats/getAllMessages) rejects a signed-in user token. Graph returns Forbidden with OnBehalfOfUser. Create it with an application token:
On the Entra app, add the application permission from the table and select Grant admin consent. The permission row must say Granted. A permission that only says it was added is not in the token.
Request a new token after consent. A token issued earlier still lacks the permission. Call
POST https://graph.microsoft.com/v1.0/subscriptionswithAuthorization: Bearerand thataccess_token.curl -s -X POST \ "https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "client_id=<client-id>" \ -d "client_secret=<client-secret>" \ -d "scope=https://graph.microsoft.com/.default" \ -d "grant_type=client_credentials"
Example subscription for messages in one channel:
{
"changeType": "created",
"notificationUrl": "https://<kibana-host>/api/actions/events/.microsoft-teams/<connector-id>?token=<ingest-token>",
"lifecycleNotificationUrl": "https://<kibana-host>/api/actions/events/.microsoft-teams/<connector-id>?token=<ingest-token>",
"resource": "teams/{team-id}/channels/{channel-id}/messages",
"expirationDateTime": "<up to 3 days from now>",
"clientState": "<secret>"
}
Subscribe to one of these resources. Tenant-wide resources accept application permissions only. A subscription to one team, channel, chat, or user accepts delegated or application permissions. /users/{user-id}/chats/getAllMessages also accepts delegated Chat.Read.
/chats starts microsoft-teams.chat_created for every new chat in the tenant. It does not deliver messages. /chats/{chat-id} watches that existing chat only. /users/{user-id}/chats watches new chats for one person and accepts delegated Chat.Read. /chats/getAllMessages starts microsoft-teams.chat_message for every new message in every chat.
| Workflow event | Application (tenant-wide) | One resource |
|---|---|---|
| Channel message posted | /teams/getAllMessages |
/teams/{team-id}/channels/{channel-id}/messages |
| Chat message received | /chats/getAllMessages or /users/{id}/chats/getAllMessages |
/chats/{chat-id}/messages |
| Channel created | /teams/getAllChannels |
/teams/{team-id}/channels |
| Chat created | /chats |
/users/{user-id}/chats |
| Team member added | — | /teams/{team-id}/members |
Grant the application permission on the Entra app and give admin consent. Delegated permissions apply only to the one-resource column.
| Workflow event | Application permission | Delegated permission (one resource) |
|---|---|---|
| Channel message posted | ChannelMessage.Read.All |
ChannelMessage.Read.All |
| Chat message received | Chat.Read.All |
Chat.Read or Chat.ReadWrite |
| Channel created | Channel.ReadBasic.All |
Channel.ReadBasic.All |
| Chat created | Chat.ReadBasic.All or Chat.Read.All |
Chat.ReadBasic or Chat.Read |
| Team member added | TeamMember.Read.All |
TeamMember.Read.All |
Quick Connect and the other delegated methods already include ChannelMessage.Read.All, Channel.ReadBasic.All, and Chat.Read. They do not include TeamMember.Read.All. Add that permission and consent again before subscribing to team members.
Tenant-wide message subscriptions (/teams/getAllMessages and /chats/getAllMessages) follow Microsoft's protected Teams APIs and license rules. Use a one-resource subscription when the tenant-wide resource is unavailable. An organization can have at most 10,000 Teams subscriptions.
When you create the subscription, Graph validates the URL with POST {notificationUrl}?validationToken=<value>. Kibana answers HTTP 200, Content-Type: text/plain, and the token as the body. That request does not start a workflow. A 201 Created response from Graph means validation succeeded. Teams itself shows nothing. Open the workflow execution to see the event.
A lifecycle notification (reauthorizationRequired, subscriptionRemoved, or missed) is acknowledged with HTTP 202 and does not start a workflow.
- HTTP 404. The ingest token does not match the connector, or Receive events was not saved before the token was rotated.
- HTTP 202. Kibana accepted the notification. The workflow must be enabled and subscribed to that event id, such as
microsoft-teams.channel_message. - A message in an existing chat does not start
microsoft-teams.chat_created. The subscription resource is/chats, which fires when a chat is created. Subscribe to/chats/getAllMessagesor/chats/{chat-id}/messagesfor messages. - Forbidden with
OnBehalfOfUser. The resource is tenant-wide and the token is a signed-in user. Use an application token. - Forbidden, required application permissions are missing. Admin consent is not Granted, or the token was issued before consent. Grant consent and request a new token.
The event does not include the post text. After microsoft-teams.channel_message, call List channel messages with event.team_id and event.channel_id. After microsoft-teams.chat_message, call List chat messages with event.chat_id. These actions use the connector's outbound credentials from Set up API credentials. The ingest token does not read message text.
Each action returns the newest messages, up to 50, not one message by id. Select the item whose id equals event.message_id. On that item, subject is plain text and body.content is HTML (<p>yeah</p>). The item can be missing when the message is no longer in the newest page. A channel reply is not in the List channel messages page.
List chat messages reads chats the signed-in user belongs to. A tenant-wide chat subscription can deliver a message from a chat that user is not in. Graph then returns 403. Sign in to the connector again after you add Chat.Read, so the stored token includes it.
Replace <connector-id> with the connector instance id. "*" subscribes to every connector of this type. execution.triggeredBy is the event id. For a channel or chat message, the later steps load subject and body.content.
version: "1"
name: Teams events
enabled: true
triggers:
- type: microsoft-teams.channel_message
connector-id: "<connector-id>"
- type: microsoft-teams.chat_message
connector-id: "<connector-id>"
- type: microsoft-teams.channel_created
connector-id: "<connector-id>"
- type: microsoft-teams.chat_created
connector-id: "<connector-id>"
- type: microsoft-teams.team_member_added
connector-id: "<connector-id>"
steps:
- name: received
type: data.set
with:
event: "{{ execution.triggeredBy }}"
team_id: "{{ event.team_id | default: '' }}"
channel_id: "{{ event.channel_id | default: '' }}"
chat_id: "{{ event.chat_id | default: '' }}"
message_id: "{{ event.message_id | default: '' }}"
user_id: "{{ event.user_id | default: '' }}"
tenant_id: "{{ event.tenant_id | default: '' }}"
- name: load_channel_messages
type: microsoft-teams.listChannelMessages
connector-id: "{{ event.connectorId }}"
if: "${{ execution.triggeredBy == 'microsoft-teams.channel_message' }}"
with:
teamId: "{{ event.team_id }}"
channelId: "{{ event.channel_id }}"
top: 50
- name: channel_post
type: data.set
if: "${{ execution.triggeredBy == 'microsoft-teams.channel_message' }}"
with:
subject: "${{ steps.load_channel_messages.output.value | where: 'id', event.message_id | map: 'subject' | first }}"
body: "${{ steps.load_channel_messages.output.value | where: 'id', event.message_id | map: 'body' | map: 'content' | first }}"
- name: load_chat_messages
type: microsoft-teams.listChatMessages
connector-id: "{{ event.connectorId }}"
if: "${{ execution.triggeredBy == 'microsoft-teams.chat_message' }}"
with:
chatId: "{{ event.chat_id }}"
top: 50
- name: chat_post
type: data.set
if: "${{ execution.triggeredBy == 'microsoft-teams.chat_message' }}"
with:
subject: "${{ steps.load_chat_messages.output.value | where: 'id', event.message_id | map: 'subject' | first }}"
body: "${{ steps.load_chat_messages.output.value | where: 'id', event.message_id | map: 'body' | map: 'content' | first }}"
POST this body to the ingest URL. It starts microsoft-teams.channel_message with team_id team-1, channel_id channel-1, message_id message-1, and tenant_id tenant-1.
curl -X POST \
'https://<kibana-host>/api/actions/events/.microsoft-teams/<connector-id>?token=<ingest-token>' \
-H 'Content-Type: application/json' \
-d '{
"value": [
{
"id": "notification-1",
"changeType": "created",
"tenantId": "tenant-1",
"resource": "teams/team-1/channels/channel-1/messages/message-1",
"resourceData": {
"@odata.type": "#Microsoft.Graph.chatMessage",
"id": "message-1"
}
}
]
}'
When you test the trigger in the workflow editor, use the emitted fields as the sample event:
{
"team_id": "team-1",
"channel_id": "channel-1",
"message_id": "message-1",
"tenant_id": "tenant-1"
}