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>
60 lines
2.1 KiB
Plaintext
60 lines
2.1 KiB
Plaintext
[role="xpack"]
|
|
[[slack-action-type]]
|
|
=== Slack connector and action
|
|
++++
|
|
<titleabbrev>Slack</titleabbrev>
|
|
++++
|
|
|
|
The Slack connector uses https://api.slack.com/incoming-webhooks[Slack Incoming Webhooks].
|
|
|
|
[float]
|
|
[[slack-connector-configuration]]
|
|
==== Connector configuration
|
|
|
|
Slack 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://api.slack.com/messaging/webhooks#getting_started[Slack 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-slack-configuration]]
|
|
==== Preconfigured connector type
|
|
|
|
[source,text]
|
|
--
|
|
my-slack:
|
|
name: preconfigured-slack-connector-type
|
|
actionTypeId: .slack
|
|
secrets:
|
|
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz'
|
|
--
|
|
|
|
Secrets defines sensitive information for the connector type.
|
|
|
|
`webhookUrl`:: A string that corresponds to *Webhook URL*.
|
|
|
|
[float]
|
|
[[slack-action-configuration]]
|
|
==== Action configuration
|
|
|
|
Slack 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-slack]]
|
|
==== Configure a Slack account
|
|
|
|
You need a https://api.slack.com/incoming-webhooks[Slack webhook URL] to
|
|
configure a Slack account. To create a webhook
|
|
URL, set up an an **Incoming Webhook Integration** through the Slack console:
|
|
|
|
. Log in to http://slack.com[slack.com] as a team administrator.
|
|
. Go to https://my.slack.com/services/new/incoming-webhook.
|
|
. Select a default channel for the integration.
|
|
+
|
|
image::images/slack-add-webhook-integration.png[]
|
|
. Click *Add Incoming Webhook Integration*.
|
|
. Copy the generated webhook URL so you can paste it into your Slack connector form.
|
|
+
|
|
image::images/slack-copy-webhook-url.png[]
|