Skip to content

Commit 7b06b81

Browse files
delannidelanni
authored
Merge branch 'main' into fix-typecheck-foundations
2 parents f44ea24 + 2bce7bb commit 7b06b81

113 files changed

Lines changed: 2603 additions & 566 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api-generated/connectors/connector-apis-passthru.asciidoc‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1015,6 +1015,7 @@ Any modifications made to this file will be overwritten.
10151015
<li><a href="#config_properties_servicenow"><code>config_properties_servicenow</code> - Connector request properties for a ServiceNow ITSM connector</a></li>
10161016
<li><a href="#config_properties_servicenow_itom"><code>config_properties_servicenow_itom</code> - Connector request properties for a ServiceNow ITSM connector</a></li>
10171017
<li><a href="#config_properties_swimlane"><code>config_properties_swimlane</code> - Connector request properties for a Swimlane connector</a></li>
1018+
<li><a href="#config_properties_torq"><code>config_properties_torq</code> - Connector request properties for a Torq connector</a></li>
10181019
<li><a href="#config_properties_webhook"><code>config_properties_webhook</code> - Connector request properties for a Webhook connector</a></li>
10191020
<li><a href="#config_properties_xmatters"><code>config_properties_xmatters</code> - Connector request properties for an xMatters connector</a></li>
10201021
<li><a href="#connector_response_properties"><code>connector_response_properties</code> - Connector response properties</a></li>
@@ -1035,6 +1036,7 @@ Any modifications made to this file will be overwritten.
10351036
<li><a href="#connector_response_properties_swimlane"><code>connector_response_properties_swimlane</code> - Connector response properties for a Swimlane connector</a></li>
10361037
<li><a href="#connector_response_properties_teams"><code>connector_response_properties_teams</code> - Connector response properties for a Microsoft Teams connector</a></li>
10371038
<li><a href="#connector_response_properties_tines"><code>connector_response_properties_tines</code> - Connector response properties for a Tines connector</a></li>
1039+
<li><a href="#connector_response_properties_torq"><code>connector_response_properties_torq</code> - Connector response properties for a Torq connector</a></li>
10381040
<li><a href="#connector_response_properties_webhook"><code>connector_response_properties_webhook</code> - Connector response properties for a Webhook connector</a></li>
10391041
<li><a href="#connector_response_properties_xmatters"><code>connector_response_properties_xmatters</code> - Connector response properties for an xMatters connector</a></li>
10401042
<li><a href="#connector_types"><code>connector_types</code> - Connector types</a></li>
@@ -1056,6 +1058,7 @@ Any modifications made to this file will be overwritten.
10561058
<li><a href="#create_connector_request_swimlane"><code>create_connector_request_swimlane</code> - Create Swimlane connector request</a></li>
10571059
<li><a href="#create_connector_request_teams"><code>create_connector_request_teams</code> - Create Microsoft Teams connector request</a></li>
10581060
<li><a href="#create_connector_request_tines"><code>create_connector_request_tines</code> - Create Tines connector request</a></li>
1061+
<li><a href="#create_connector_request_torq"><code>create_connector_request_torq</code> - Create Torq connector request</a></li>
10591062
<li><a href="#create_connector_request_webhook"><code>create_connector_request_webhook</code> - Create Webhook connector request</a></li>
10601063
<li><a href="#create_connector_request_xmatters"><code>create_connector_request_xmatters</code> - Create xMatters connector request</a></li>
10611064
<li><a href="#features"><code>features</code> - </a></li>
@@ -1106,6 +1109,7 @@ Any modifications made to this file will be overwritten.
11061109
<li><a href="#secrets_properties_slack_webhook"><code>secrets_properties_slack_webhook</code> - Connector secrets properties for a Webhook Slack connector</a></li>
11071110
<li><a href="#secrets_properties_swimlane"><code>secrets_properties_swimlane</code> - Connector secrets properties for a Swimlane connector</a></li>
11081111
<li><a href="#secrets_properties_teams"><code>secrets_properties_teams</code> - Connector secrets properties for a Microsoft Teams connector</a></li>
1112+
<li><a href="#secrets_properties_torq"><code>secrets_properties_torq</code> - Connector secrets properties for a Torq connector</a></li>
11091113
<li><a href="#secrets_properties_webhook"><code>secrets_properties_webhook</code> - Connector secrets properties for a Webhook connector</a></li>
11101114
<li><a href="#secrets_properties_xmatters"><code>secrets_properties_xmatters</code> - Connector secrets properties for an xMatters connector</a></li>
11111115
<li><a href="#updateConnector_400_response"><code>updateConnector_400_response</code> - </a></li>
@@ -1124,6 +1128,7 @@ Any modifications made to this file will be overwritten.
11241128
<li><a href="#update_connector_request_slack_webhook"><code>update_connector_request_slack_webhook</code> - Update Slack connector request</a></li>
11251129
<li><a href="#update_connector_request_swimlane"><code>update_connector_request_swimlane</code> - Update Swimlane connector request</a></li>
11261130
<li><a href="#update_connector_request_teams"><code>update_connector_request_teams</code> - Update Microsoft Teams connector request</a></li>
1131+
<li><a href="#update_connector_request_torq"><code>update_connector_request_torq</code> - Update Torq connector request</a></li>
11271132
<li><a href="#update_connector_request_webhook"><code>update_connector_request_webhook</code> - Update Webhook connector request</a></li>
11281133
<li><a href="#update_connector_request_xmatters"><code>update_connector_request_xmatters</code> - Update xMatters connector request</a></li>
11291134
</ol>
@@ -1529,6 +1534,13 @@ Any modifications made to this file will be overwritten.
15291534
<div class="param">mappings (optional)</div><div class="param-desc"><span class="param-type"><a href="#Connector_mappings_properties_for_a_Swimlane_connector">Connector_mappings_properties_for_a_Swimlane_connector</a></span> </div>
15301535
</div> <!-- field-items -->
15311536
</div>
1537+
<div class="model">
1538+
<h3><a name="config_properties_torq"><code>config_properties_torq</code> - Connector request properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
1539+
<div class='model-description'>Defines properties for connectors when type is <code>.torq</code>.</div>
1540+
<div class="field-items">
1541+
<div class="param">webhookIntegrationUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The endpoint URL of the Elastic Security integration in Torq. </div>
1542+
</div> <!-- field-items -->
1543+
</div>
15321544
<div class="model">
15331545
<h3><a name="config_properties_webhook"><code>config_properties_webhook</code> - Connector request properties for a Webhook connector</a> <a class="up" href="#__Models">Up</a></h3>
15341546
<div class='model-description'>Defines properties for connectors when type is <code>.webhook</code>.</div>
@@ -1842,6 +1854,22 @@ Any modifications made to this file will be overwritten.
18421854
<div class="param">is_missing_secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type. </div>
18431855
<div class="param">is_preconfigured </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether it is a preconfigured connector. If true, the <code>config</code> and <code>is_missing_secrets</code> properties are omitted from the response. </div>
18441856
<div class="param">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </div>
1857+
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
1858+
</div> <!-- field-items -->
1859+
</div>
1860+
<div class="model">
1861+
<h3><a name="connector_response_properties_torq"><code>connector_response_properties_torq</code> - Connector response properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
1862+
<div class='model-description'></div>
1863+
<div class="field-items">
1864+
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_torq">config_properties_torq</a></span> </div>
1865+
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
1866+
<div class="param-enum-header">Enum:</div>
1867+
<div class="param-enum">.torq</div>
1868+
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. </div>
1869+
<div class="param">is_deprecated </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector type is deprecated. </div>
1870+
<div class="param">is_missing_secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type. </div>
1871+
<div class="param">is_preconfigured </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether it is a preconfigured connector. If true, the <code>config</code> and <code>is_missing_secrets</code> properties are omitted from the response. </div>
1872+
<div class="param">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </div>
18451873
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
18461874
</div> <!-- field-items -->
18471875
</div>
@@ -2093,6 +2121,18 @@ Any modifications made to this file will be overwritten.
20932121
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> Defines secrets for connectors when type is <code>.tines</code>. </div>
20942122
</div> <!-- field-items -->
20952123
</div>
2124+
<div class="model">
2125+
<h3><a name="create_connector_request_torq"><code>create_connector_request_torq</code> - Create Torq connector request</a> <a class="up" href="#__Models">Up</a></h3>
2126+
<div class='model-description'>The Torq connector uses a Torq webhook to trigger workflows with Kibana actions.</div>
2127+
<div class="field-items">
2128+
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_torq">config_properties_torq</a></span> </div>
2129+
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
2130+
<div class="param-enum-header">Enum:</div>
2131+
<div class="param-enum">.torq</div>
2132+
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
2133+
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_torq">secrets_properties_torq</a></span> </div>
2134+
</div> <!-- field-items -->
2135+
</div>
20962136
<div class="model">
20972137
<h3><a name="create_connector_request_webhook"><code>create_connector_request_webhook</code> - Create Webhook connector request</a> <a class="up" href="#__Models">Up</a></h3>
20982138
<div class='model-description'>The Webhook connector uses axios to send a POST or PUT request to a web service.</div>
@@ -2560,6 +2600,13 @@ Any modifications made to this file will be overwritten.
25602600
<div class="param">webhookUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The URL of the incoming webhook. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. </div>
25612601
</div> <!-- field-items -->
25622602
</div>
2603+
<div class="model">
2604+
<h3><a name="secrets_properties_torq"><code>secrets_properties_torq</code> - Connector secrets properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
2605+
<div class='model-description'>Defines secrets for connectors when type is <code>.torq</code>.</div>
2606+
<div class="field-items">
2607+
<div class="param">token </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The secret of the webhook authentication header. </div>
2608+
</div> <!-- field-items -->
2609+
</div>
25632610
<div class="model">
25642611
<h3><a name="secrets_properties_webhook"><code>secrets_properties_webhook</code> - Connector secrets properties for a Webhook connector</a> <a class="up" href="#__Models">Up</a></h3>
25652612
<div class='model-description'>Defines secrets for connectors when type is <code>.webhook</code>.</div>
@@ -2718,6 +2765,15 @@ Any modifications made to this file will be overwritten.
27182765
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_teams">secrets_properties_teams</a></span> </div>
27192766
</div> <!-- field-items -->
27202767
</div>
2768+
<div class="model">
2769+
<h3><a name="update_connector_request_torq"><code>update_connector_request_torq</code> - Update Torq connector request</a> <a class="up" href="#__Models">Up</a></h3>
2770+
<div class='model-description'></div>
2771+
<div class="field-items">
2772+
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_torq">config_properties_torq</a></span> </div>
2773+
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
2774+
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_torq">secrets_properties_torq</a></span> </div>
2775+
</div> <!-- field-items -->
2776+
</div>
27212777
<div class="model">
27222778
<h3><a name="update_connector_request_webhook"><code>update_connector_request_webhook</code> - Update Webhook connector request</a> <a class="up" href="#__Models">Up</a></h3>
27232779
<div class='model-description'></div>

‎docs/management/action-types.asciidoc‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,18 @@ Connectors provide a central place to store connection information for services
77
[cols="2"]
88
|===
99

10+
a| <<d3security-action-type,D3 Security>>
11+
12+
| Send a request to D3 Security.
13+
1014
a| <<email-action-type,Email>>
1115

1216
| Send email from your server.
1317

18+
a| <<gen-ai-action-type,Generative AI>>
19+
20+
| Send a request to OpenAI.
21+
1422
a| <<resilient-action-type,{ibm-r}>>
1523

1624
| Create an incident in {ibm-r}.
@@ -63,6 +71,10 @@ a| <<tines-action-type,Tines>>
6371

6472
| Send events to a Tines Story.
6573

74+
a| <<torq-action-type,Torq>>
75+
76+
| Trigger a Torq workflow.
77+
6678
a| <<webhook-action-type, {webhook}>>
6779

6880
| Send a request to a web service.
@@ -75,18 +87,6 @@ a| <<xmatters-action-type,xMatters>>
7587

7688
| Send actionable alerts to on-call xMatters resources.
7789

78-
a| <<torq-action-type,Torq>>
79-
80-
| Trigger a Torq workflow.
81-
82-
a| <<gen-ai-action-type,Generative AI>>
83-
84-
| Send a request to OpenAI.
85-
86-
a| <<d3security-action-type,D3 Security>>
87-
88-
| Send a request to D3 Security.
89-
9090
|===
9191

9292
[NOTE]

‎docs/management/connectors/action-types/torq.asciidoc‎

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
++++
44
<titleabbrev>Torq</titleabbrev>
55
++++
6+
:frontmatter-description: Add a connector that can use Torq to trigger workflows.
7+
:frontmatter-tags-products: [kibana]
8+
:frontmatter-tags-content-type: [how-to]
9+
:frontmatter-tags-user-goals: [configure]
610

711
The Torq connector uses a Torq webhook to trigger workflows with Kibana actions.
812

@@ -27,34 +31,6 @@ Torq endpoint URL:: Endpoint URL (webhook) of the Elastic Security integration y
2731

2832
Torq authentication header secret:: Secret of the webhook authentication header.
2933

30-
[float]
31-
[[preconfigured-torq-configuration]]
32-
=== Create preconfigured connectors
33-
34-
If you are running {kib} on-prem, you can define connectors by
35-
adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
36-
For example:
37-
38-
[source,yaml]
39-
--
40-
xpack.actions.preconfigured:
41-
my-torq:
42-
name: preconfigured-torq-connector-type
43-
actionTypeId: .torq
44-
config:
45-
webhookIntegrationUrl: https://hooks.torq.io/v1/somehook
46-
secrets:
47-
token: mytorqtoken
48-
--
49-
50-
Config defines information for the connector type.
51-
52-
`webhookIntegrationUrl`:: An address that corresponds to **Torq endpoint URL**.
53-
54-
Secrets defines sensitive information for the connector type.
55-
56-
`token`:: A string that corresponds to **Torq authentication header secret**.
57-
5834
[float]
5935
[[torq-action-configuration]]
6036
=== Test connectors

‎docs/management/connectors/index.asciidoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1+
include::action-types/d3security.asciidoc[leveloffset=+1]
12
include::action-types/email.asciidoc[leveloffset=+1]
3+
include::action-types/gen-ai.asciidoc[leveloffset=+1]
24
include::action-types/resilient.asciidoc[leveloffset=+1]
35
include::action-types/index.asciidoc[leveloffset=+1]
46
include::action-types/jira.asciidoc[leveloffset=+1]
@@ -16,6 +18,4 @@ include::action-types/torq.asciidoc[leveloffset=+1]
1618
include::action-types/webhook.asciidoc[leveloffset=+1]
1719
include::action-types/cases-webhook.asciidoc[leveloffset=+1]
1820
include::action-types/xmatters.asciidoc[leveloffset=+1]
19-
include::action-types/gen-ai.asciidoc[leveloffset=+1]
20-
include::action-types/d3security.asciidoc[leveloffset=+1]
2121
include::pre-configured-connectors.asciidoc[leveloffset=+1]

‎docs/management/connectors/pre-configured-connectors.asciidoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,13 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
113113
* <<preconfigured-resilient-configuration>>
114114
* <<preconfigured-index-configuration>>
115115
* <<preconfigured-jira-configuration>>
116+
* <<preconfigured-teams-configuration>>
116117
* <<preconfigured-opsgenie-configuration>>
117118
* <<preconfigured-pagerduty-configuration>>
118119
* <<preconfigured-server-log-configuration>>
119120
* <<preconfigured-slack-configuration>>
120121
* <<preconfigured-swimlane-configuration>>
122+
* <<preconfigured-torq-configuration>>
121123
* <<preconfigured-webhook-configuration>>
122124
* <<preconfigured-cases-webhook-configuration>>
123125
* <<preconfigured-xmatters-configuration>>
@@ -528,6 +530,26 @@ xpack.actions.preconfigured:
528530
<3> Field mappings for properties such as the alert identifer, severity, and rule name.
529531
<4> The API authentication token for HTTP basic authentication. NOTE: This value should be stored in the <<creating-keystore, {kib} keystore>>.
530532

533+
[float]
534+
[[preconfigured-torq-configuration]]
535+
==== Torq connectors
536+
537+
The following example creates a <<torq-action-type,Torq connector>>:
538+
539+
[source,yaml]
540+
--
541+
xpack.actions.preconfigured:
542+
my-torq:
543+
name: preconfigured-torq-connector-type
544+
actionTypeId: .torq
545+
config:
546+
webhookIntegrationUrl: https://hooks.torq.io/v1/somehook <1>
547+
secrets:
548+
token: mytorqtoken <2>
549+
--
550+
<1> The endpoint URL of the Elastic Security integration in Torq.
551+
<2> The secret of the webhook authentication header.
552+
531553
[float]
532554
[[preconfigured-webhook-configuration]]
533555
==== Webhook connectors

‎docs/settings/alert-action-settings.asciidoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -432,6 +432,9 @@ For an <<xmatters-action-type,xMatters connector>>, specifies whether it uses HT
432432
`xpack.actions.preconfigured.<connector-id>.config.viewIncidentUrl`::
433433
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.
434434

435+
`xpack.actions.preconfigured.<connector-id>.config.webhookIntegrationUrl`::
436+
For a <<torq-action-type,Torq connector>>, specifies the endpoint URL of the Elastic Security integration in Torq.
437+
435438
`xpack.actions.preconfigured.<connector-id>.name`::
436439
The name of the preconfigured connector.
437440

@@ -492,6 +495,7 @@ A token secret that varies by connector:
492495
--
493496
* For a <<d3security-action-type,D3 Security conector>>, specifies the D3 Security token.
494497
* For a <<slack-action-type,Slack connector>>, specifies the Slack bot user OAuth token.
498+
* For a <<torq-action-type,Torq connector>>, specifies the secret of the webhook authentication header.
495499
--
496500

497501
`xpack.actions.preconfigured.<connector-id>.secrets.user`::

0 commit comments

Comments
 (0)