github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Edit Tines connector (#145168)

Browse source
This commit is contained in:
Lisa Cawley 2022-11-15 07:35:13 -08:00 • committed by GitHub
parent 731c8b962b
commit 413e813b15
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/management/connectors/action-types/tines.asciidoc
View file

@ -13,12 +13,12 @@ The Tines connector uses Tines's https://www.tines.com/docs/actions/types/webhoo
Tines connectors have the following configuration properties.
URL:: The Tines tenant URL. If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
URL:: The Tines tenant URL. If you are using the <<action-settings,`xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
Email:: The email used to sign in to Tines.
API Token:: A Tines API token created by the user. https://www.tines.com/api/authentication#generate-api-token[Docs]
API Token:: A Tines API token created by the user. For more information, refer to the https://www.tines.com/api/authentication#generate-api-token[Tines documentation].
[role="screenshot"]
image::../images/tines-connector.png[Tines connector]
image::management/connectors/images/tines-connector.png[Tines connector]
[float]
[[Preconfigured-tines-configuration]]
@ -57,30 +57,30 @@ Webhook:: The Webhook action from the previous story that will receive the event
Test Tines action parameters.
[role="screenshot"]
image::../images/tines-params-test.png[Tines params test]
image::management/connectors/images/tines-params-test.png[Tines params test]
[float]
[[tines-action-format]]
=== Actions
Once the Tines connector has been configured in an Alerting Rule.
Once the Tines connector has been configured in an alerting rule:
[role="screenshot"]
image::../images/tines-alerting.png[Tines rule alert]
image::management/connectors/images/tines-alerting.png[Tines rule alert]
It will send a POST request to the Tines webhook action on every action execution with at least one result.
It will send a POST request to the Tines webhook action on every action that runs with at least one result.
[float]
[[webhookUrlFallback-tines-configuration]]
==== Webhook URL fallback
It is possible for the requests to the Tines API, to get the stories and webhooks for the selectors, to hit the 500 results limit; in this scenario, the webhook URL fallback text field will be displayed.
Users can still use the selectors if the story or webhook exists in the 500 options loaded. Otherwise, users can paste the webhook URL in the test input field, it can be copied from the Tines webhook configuration.
It is possible that requests to the Tines API to get the stories and webhooks for the selectors hit the 500 results limit. In this scenario, the webhook URL fallback text field will be displayed.
You can still use the selectors if the story or webhook exists in the 500 options loaded. Otherwise, you can paste the webhook URL in the test input field; it can be copied from the Tines webhook configuration.
When the webhook URL is defined, the connector will use it directly in the execution stage, and the story and webhook selectors will be disabled and ignored. To re-enable the story and webhook selectors, remove the webhook URL value.
When the webhook URL is defined, the connector will use it directly when an action runs, and the story and webhook selectors will be disabled and ignored. To re-enable the story and webhook selectors, remove the webhook URL value.
[role="screenshot"]
image::../images/tines-webhook-url-fallback.png[Tines Webhook URL fallback]
image::management/connectors/images/tines-webhook-url-fallback.png[Tines Webhook URL fallback]
[float]
[[tines-story-library]]
@ -90,7 +90,7 @@ In order to simplify the integration with Elastic, Tines offers a set of pre-def
They can be found by searching for "Elastic" in the Tines Story library:
[role="screenshot"]
image::../images/tines_elastic_stories.png[Tines Elastic stories]
image::management/connectors/images/tines_elastic_stories.png[Tines Elastic stories]
They can be imported directly into your Tines tenant.
@ -98,7 +98,7 @@ They can be imported directly into your Tines tenant.
Tines connector will send the data in JSON format.
The message contains execution specific fields, such as `alertId`, `date`, `_index`, `kibanaBaseUrl`, along with the `rule` and `params` objects.
The message contains fields such as `alertId`, `date`, `_index`, `kibanaBaseUrl`, along with the `rule` and `params` objects.
The number of alerts (signals) can be found at `state.signals_count`.

2
docs/management/connectors/index.asciidoc
View file

@ -14,5 +14,5 @@ include::action-types/webhook.asciidoc[]
include::action-types/cases-webhook.asciidoc[leveloffset=+1]
include::action-types/opsgenie.asciidoc[]
include::action-types/xmatters.asciidoc[]
include::action-types/tines.asciidoc[]
include::action-types/tines.asciidoc[leveloffset=+1]
include::pre-configured-connectors.asciidoc[]