You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/management/connectors/action-types/teams.asciidoc
+4-22Lines changed: 4 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,10 @@
3
3
++++
4
4
<titleabbrev>Microsoft Teams</titleabbrev>
5
5
++++
6
+
:frontmatter-description: Add a connector that can send messages to a Microsoft Teams channel.
7
+
:frontmatter-tags-products: [kibana]
8
+
:frontmatter-tags-content-type: [how-to]
9
+
:frontmatter-tags-user-goals: [configure]
6
10
7
11
The Microsoft Teams connector uses https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook[Incoming Webhooks].
8
12
@@ -25,28 +29,6 @@ Microsoft Teams connectors have the following configuration properties:
25
29
Name:: The name of the connector.
26
30
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.
27
31
28
-
[float]
29
-
[[preconfigured-teams-configuration]]
30
-
=== Create preconfigured connectors
31
-
32
-
If you are running {kib} on-prem, you can define connectors by
33
-
adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
Copy file name to clipboardExpand all lines: docs/management/connectors/action-types/xmatters.asciidoc
+7-54Lines changed: 7 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,59 +33,12 @@ xMatters connectors have the following configuration properties:
33
33
34
34
Name:: The name of the connector.
35
35
Authentication Type:: The type of authentication used in the request made to xMatters.
36
-
URL:: The request URL for the Elastic Alerts trigger in xMatters. If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
37
-
Username:: Username for HTTP Basic Authentication.
38
-
Password:: Password for HTTP Basic Authentication.
39
-
40
-
[float]
41
-
[[preconfigured-xmatters-configuration]]
42
-
=== Create preconfigured connectors
43
-
44
-
If you are running {kib} on-prem, you can define connectors by
45
-
adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
46
-
For example:
47
-
48
-
Connector using Basic Authentication
49
-
[source,text]
50
-
--
51
-
xpack.actions.preconfigured:
52
-
my-xmatters:
53
-
name: preconfigured-xmatters-connector-type
54
-
actionTypeId: .xmatters
55
-
config:
56
-
configUrl: https://test.host
57
-
usesBasic: true
58
-
secrets:
59
-
user: testuser
60
-
password: passwordkeystorevalue
61
-
--
62
-
63
-
Connector using URL Authentication
64
-
[source,text]
65
-
--
66
-
xpack.actions.preconfigured:
67
-
my-xmatters:
68
-
name: preconfigured-xmatters-connector-type
69
-
actionTypeId: .xmatters
70
-
config:
71
-
usesBasic: false
72
-
secrets:
73
-
secretsUrl: https://test.host?apiKey=1234-abcd
74
-
--
75
-
76
-
Config defines information for the connector type:
77
-
78
-
`configUrl`:: A URL string that corresponds to *URL*. Only used if `usesBasic` is true.
79
-
80
-
`usesBasic`:: A boolean that corresponds to *Authentication Type*. If `true`, this connector will require values for `user` and `password` inside the secrets configuration. Defaults to `true`.
81
-
82
-
Secrets defines sensitive information for the connector type:
83
-
84
-
`user`:: A string that corresponds to *User*. Required if `usesBasic` is set to `true`.
85
-
86
-
`password`:: A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>. Required if `usesBasic` is set to `true`.
87
-
88
-
`secretsUrl`:: A URL string that corresponds to *URL*. Only used if `usesBasic` is false, indicating the API key is included in the URL.
36
+
URL::
37
+
The request URL for the Elastic Alerts trigger in xMatters.
38
+
If you are using URL authentication, include the API key in the URL. For example, `https://example.com?apiKey=1234-abcd`.
39
+
If you are using the <<action-settings,`xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
40
+
Username:: Username for HTTP basic authentication.
41
+
Password:: Password for HTTP basic authentication.
<14> A stringified JSON payload with Mustache variables that is sent to the create comment URL to create a case comment.
293
311
<15> A user name, which is required when `hasAuth` is `true`.
294
312
<16> A password, which is required when `hasAuth` is `true`.
313
+
314
+
[float]
315
+
[[preconfigured-xmatters-configuration]]
316
+
==== xMatters connectors
317
+
318
+
The following example creates an <<xmatters-action-type,xMatters connector>> with basic authentication:
319
+
320
+
[source,text]
321
+
--
322
+
xpack.actions.preconfigured:
323
+
my-xmatters:
324
+
name: preconfigured-xmatters-connector-type
325
+
actionTypeId: .xmatters
326
+
config:
327
+
configUrl: https://test.host <1>
328
+
usesBasic: true <2>
329
+
secrets:
330
+
user: testuser <3>
331
+
password: passwordkeystorevalue <4>
332
+
--
333
+
<1> The request URL for the Elastic Alerts trigger in xMatters.
334
+
<2> Indicates whether the connector uses HTTP basic authentication. If `true`, you must provide `user` and `password` values. Defaults to `true`.
335
+
<3> A user name for authentication, which is required when `usesBasic` is `true`.
336
+
<4> A password for authentication, which is required when `usesBasic` is `true`. NOTE: This value should be stored in the <<creating-keystore,{kib} keystore>>.
337
+
338
+
The following example creates an xMatters connector with URL authentication:
For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies a stringified JSON payload with Mustache variables that is sent to the create comment URL to create a case comment. The required variable is `case.description`.
274
277
+
@@ -336,6 +339,9 @@ For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies the REST A
336
339
+
337
340
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname in the URL is added to the allowed hosts.
For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies a URL string with either the external service ID or external service title Mustache variable to view a case in the external system.
341
347
@@ -365,17 +371,30 @@ A password secret that varies by connector:
365
371
+
366
372
--
367
373
* For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies a password that is required when `xpack.actions.preconfigured.<connector-id>.config.hasAuth` is `true`.
374
+
* For an <<xmatters-action-type,xMatters connector>>, specifies a password that is required when `xpack.actions.preconfigured.<connector-id>.config.usesBasic` is `true`.
For a <<pagerduty-action-type,PagerDuty connector>>, specifies the 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key.
For an <<xmatters-action-type,xMatters connector>> with URL authentication, specifies the request URL for the Elastic Alerts trigger in xMatters with the API key included in the URL.
382
+
It is used only when `xpack.actions.preconfigured.<connector-id>.config.usesBasic` is `false`.
383
+
+
384
+
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts.
* For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies a user name that is required when `xpack.actions.preconfigured.<connector-id>.config.hasAuth` is `true`.
391
+
* For an <<xmatters-action-type,xMatters connector>>, specifies a user name that is required when `xpack.actions.preconfigured.<connector-id>.config.usesBasic` is `true`.
0 commit comments