IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Webhook action
editWebhook action
editThe Webhook action type uses axios to send a POST or PUT request to a web service.
Connector configuration
editWebhook 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.
- URL
-
The request URL. If you are using the
xpack.actions.allowedHosts
setting, make sure the hostname is added to the allowed hosts. - Method
-
HTTP request method, either
post
(default) orput
. - Headers
- A set of key-value pairs sent as headers with the request
- User
- An optional username. If set, HTTP basic authentication is used. Currently only basic authentication is supported.
- Password
- An optional password. If set, HTTP basic authentication is used. Currently only basic authentication is supported.
Preconfigured action type
editmy-webhook: name: preconfigured-webhook-action-type actionTypeId: .webhook config: url: https://test.host method: POST headers: testheader: testvalue secrets: user: testuser password: passwordkeystorevalue
config
defines the action type specific to the configuration and contains the following properties:
|
A URL string that corresponds to URL. |
|
A string that corresponds to Method. |
|
A record<string, string> that corresponds to Headers. |
secrets
defines sensitive information for the action type:
|
A string that corresponds to User. |
|
A string that corresponds to Password. Should be stored in the Kibana keystore. |
Action configuration
editWebhook actions have the following properties:
- Body
- A json payload sent to the request URL.