a7c9d3f1e0
* Renaming alerts to rules * Updating formatted messages * Updating i18n labels * Completed renaming in UI * Updating client routes including redirect * wip docs update * Reverting title changes for now * Fixing types check * Fixing unit tests * Fixing functional test * Fixing functional test * docs wip * wip docs update * Finished first run through docs * docs docs docs * Fixing bad merge * Fixing functional test * Docs cleanup * Cleaning up i18n labels * Fixing functional test * Updating screenshots * Updating screenshots * Updating screenshots * Updating terminology in alerting examples * Updating terminology in alerting examples Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
61 lines
2.6 KiB
Plaintext
61 lines
2.6 KiB
Plaintext
[role="xpack"]
|
|
[[teams-action-type]]
|
|
=== Microsoft Teams connector and action
|
|
++++
|
|
<titleabbrev>Microsoft Teams</titleabbrev>
|
|
++++
|
|
|
|
The Microsoft Teams connector uses https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook[Incoming Webhooks].
|
|
|
|
[float]
|
|
[[teams-connector-configuration]]
|
|
==== Connector configuration
|
|
|
|
Microsoft Teams connectors have the following configuration properties.
|
|
|
|
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
|
|
Webhook URL:: The URL of the incoming webhook. See https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook#add-an-incoming-webhook-to-a-teams-channel[Add Incoming Webhooks] for instructions on generating this URL. If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
|
|
|
|
[float]
|
|
[[Preconfigured-teams-configuration]]
|
|
==== Preconfigured connector type
|
|
|
|
[source,text]
|
|
--
|
|
my-teams:
|
|
name: preconfigured-teams-connector-type
|
|
actionTypeId: .teams
|
|
secrets:
|
|
webhookUrl: 'https://outlook.office.com/webhook/abcd@0123456/IncomingWebhook/abcdefgh/ijklmnopqrstuvwxyz'
|
|
--
|
|
|
|
Secrets defines sensitive information for the connector type.
|
|
|
|
`webhookUrl`:: A string that corresponds to *Webhook URL*.
|
|
|
|
[float]
|
|
[[teams-action-configuration]]
|
|
==== Action configuration
|
|
|
|
Microsoft Teams actions have the following properties.
|
|
|
|
Message:: The message text, converted to the `text` field in the Webhook JSON payload. Currently only the text field is supported. Markdown, images, and other advanced formatting are not yet supported.
|
|
|
|
[[configuring-teams]]
|
|
==== Configure a Microsoft Teams account
|
|
|
|
You need a https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook[Microsoft Teams webhook URL] to
|
|
configure a Microsoft Teams action. To create a webhook
|
|
URL, add the **Incoming Webhook App** through the Microsoft Teams console:
|
|
|
|
. Log in to http://teams.microsoft.com[teams.microsoft.com] as a team administrator.
|
|
. Navigate to the Apps directory, search for and select the *Incoming Webhook* app.
|
|
. Choose _Add to team_ and select a team and channel for the app.
|
|
. Enter a name for your webhook and (optionally) upload a custom icon.
|
|
+
|
|
image::images/teams-add-webhook-integration.png[]
|
|
. Click *Create*.
|
|
. Copy the generated webhook URL so you can paste it into your Teams connector form.
|
|
+
|
|
image::images/teams-copy-webhook-url.png[]
|