- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 7.12
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Development tools settings
- Graph settings
- Fleet settings
- i18n settings
- Logs settings
- Metrics settings
- Machine learning settings
- Monitoring settings
- Reporting settings
- Secure settings
- Search sessions settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Embed Kibana content in a web page
- Configure monitoring
- Configure security
- Production considerations
- Discover
- Dashboard
- Canvas
- Maps
- Machine learning
- Graph
- Observability
- APM
- Elastic Security
- Dev Tools
- Stack Monitoring
- Stack Management
- Fleet
- Reporting
- Alerting and Actions
- REST API
- Kibana plugins
- Accessibility
- Release notes
- Developer guide
Preconfigured connectors and action types
editPreconfigured connectors and action types
editYou can preconfigure a connector or action type to have all the information it needs prior to startup
by adding it to the kibana.yml
file.
Preconfigured connectors offer the following capabilities:
- 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.
A preconfigured action type has only preconfigured connectors. Preconfigured connectors can belong to either the preconfigured action type or to the regular action type.
Preconfigured connectors
editThis 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 action connector identifier, |
|
|
|
|
|
|
|
|
Sensitive properties, such as passwords, can also be stored in the Kibana keystore.
When you open the main menu, click Stack Management > Alerts and Actions. Preconfigured connectors appear on the Connectors tab, regardless of which space you are in. They are tagged as “preconfigured”, and you cannot delete them.

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

The connector details preview is disabled for preconfigured connectors of a preconfigured action type.

Preconfigured action type
editThis example shows a preconfigured action type with one out-of-the box connector.
xpack.actions.enabledActionTypes: ['.slack', '.email', '.index'] xpack.actions.preconfigured: my-server-log: actionTypeId: .server-log name: 'Server log #xyz'
|
|
|
To attach a preconfigured action to an alert:
- Open the main menu, click Stack Management > Alerts and Actions, then open the Connectors tab.
- Click Create connector.
-
In the list of available action types, select the preconfigured action type you want.
-
In Create alert, open the connector dropdown, and then select the preconfigured connector.
The
preconfigured
label distinguishes it from a space-aware connector. - Click Add action.