mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
55 lines
1.7 KiB
Text
55 lines
1.7 KiB
Text
[[<ACTION-TYPE>-action-type]]
|
|
== <ACTION-TYPE> connector and action
|
|
++++
|
|
<titleabbrev><ACTION-TYPE></titleabbrev>
|
|
++++
|
|
|
|
Include a short description of the connector type.
|
|
|
|
[float]
|
|
[[define-<ACTION-TYPE>-ui]]
|
|
=== Create connectors in {kib}
|
|
|
|
You can create connectors in *{stack-manage-app} > {connectors-ui}*
|
|
or as needed when you're creating a rule.
|
|
|
|
// Optionally add a screenshot
|
|
|
|
[float]
|
|
[[<ACTION-TYPE>-connector-configuration]]
|
|
==== Connector configuration
|
|
|
|
<ACTION-TYPE> connectors have the following configuration properties:
|
|
|
|
////
|
|
List of user-facing connector configurations. This should align with the fields available in the Create connector flyout form for this connector type.
|
|
////
|
|
|
|
Property1:: A short description of this property.
|
|
Property2:: A short description of this property with format hints. This can be specified in `this specific format`.
|
|
|
|
////
|
|
Add preconfigured settings for this connector type in alert-action-settings.asciidoc and an example in pre-configured-connectors.asciidoc.
|
|
////
|
|
|
|
[float]
|
|
[[<ACTION-TYPE>-action-configuration]]
|
|
=== Test connectors
|
|
|
|
You can test connectors with the <<execute-connector-api,run connector API>> or
|
|
as you're creating or editing the connector in {kib}.
|
|
|
|
<ACTION-TYPE> actions have the following properties.
|
|
|
|
////
|
|
List of user-facing action configurations. This should align with the fields available in the Action section of the Create/Update alert flyout.
|
|
////
|
|
|
|
Property1:: A short description of this property.
|
|
Property2:: A short description of this property with format hints. This can be specified in `this specific format`.
|
|
|
|
////
|
|
Optional - additional configuration details here
|
|
[[configuring-<ACTION-TYPE>]]
|
|
==== Configure <ACTION-TYPE>
|
|
////
|