IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Webhook connector and action License Management »
Elastic Docs ›Kibana Guide [7.13] ›Stack Management ›Connectors

Preconfigured connectors

edit

Preconfigured connectors

edit

You can preconfigure a connector to have all the information it needs prior to startup by adding it to the kibana.yml file.

Preconfigured connectors offer the following benefits:

  • Require no setup. Configuration and credentials needed to execute an action are predefined, including the connector name and ID.
  • Appear in all spaces because they are not saved objects.
  • Cannot be edited or deleted.

Preconfigured connectors example

edit

This example shows a valid configuration for two out-of-the box connectors: Slack and Webhook.

  xpack.actions.preconfigured:
    my-slack1:                  
      actionTypeId: .slack      
      name: 'Slack #xyz'        
      secrets:
        webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz'
    webhook-service:
      actionTypeId: .webhook
      name: 'Email service'
      config:                   
        url: 'https://email-alert-service.elastic.co'
        method: post
        headers:
          header1: value1
          header2: value2
      secrets:                  
        user: elastic
        password: changeme

The key is the connector identifier, my-slack1 in this example.

actionTypeId is the action type identifier.

name is the name of the preconfigured connector.

config is the configuration specific to the connector type.

secrets is the sensitive configuration, such as username, password, and keys, specific to the connector type.

Sensitive properties, such as passwords, can also be stored in the Kibana keystore.

Built-in preconfigured connectors

edit

Kibana provides one built-in preconfigured connector:

View preconfigured connectors

edit

When you open the main menu, click Stack Management > Rules and Connectors. Preconfigured connectors appear on the Connectors tab, regardless of which space you are in. They are tagged as “preconfigured”, and you cannot delete them.

Connectors managing tab with pre-configured

Clicking a preconfigured connector shows the description, but not the configuration. A message indicates that this is a preconfigured connector.

Pre-configured connector view details
« Webhook connector and action License Management »