
Custom alert action component reference
Review required and optional custom alert action components and app directory structure.
App directory structure
Here is the directory layout of an app that includes a custom alert action.
[app_name] appserver static [app_icon].png [alternative_icon].png bin [custom_alert_action_script] default alert_actions.conf app.conf restmap.conf setup.xml data ui alerts [custom_alert_action].html metadata default.meta README alert_actions.conf.spec savedsearches.conf.spec
App components
This app directory has the following components.
Component | File | Description | Required? |
---|---|---|---|
Logic | [custom_alert_action_script] | Alert action script or executable file | Yes |
User interface | [custom_alert_action].html
|
HTML file defining the user interface for alert configuration | Yes |
Alert action configuration | alert_actions.conf
|
Registers the custom alert action | Yes |
Spec files | alert_actions.conf.spec
|
Declares alert action parameters | Optional |
savedsearches.conf.spec
|
Declares alert action parameters configured in the local savedsearches.conf file for the Splunk platform instance.
|
Optional | |
App configuration | app.conf
|
Defines app package and UI information | Yes |
Icons | [app_icon].png
|
One or more icon image file(s) | Optional |
Setup | setup.xml
|
Defines a UI for populating global settings at setup time | Optional |
Validation | restmap.conf
|
Defines validation for parameters declared in savedsearches.conf
|
Optional |
Access control metadata | default.meta
|
Defines alert action permission and scope | Optional |
Confidential information storage
Additionally, you can opt to use the password storage endpoint to store confidential information in an encrypted format. See Confidential information storage.
PREVIOUS Custom alert actions overview |
NEXT Set up custom alert configuration files |
This documentation applies to the following versions of Splunk® Enterprise: 6.5.7, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.8, 7.1.7, 7.0.0, 7.3.7, 8.0.2, 8.0.3, 8.0.4, 8.0.5, 8.0.6, 8.0.7, 8.0.8, 8.0.9, 8.0.10, 8.1.0, 8.1.1, 8.1.2, 8.1.3, 8.1.4, 8.1.5, 8.1.6, 8.1.7, 8.1.8, 8.1.9, 8.1.10, 8.1.11, 8.1.12, 8.2.0, 8.2.1, 8.2.2, 8.2.3, 8.2.4, 8.2.5, 8.2.6, 8.2.7, 8.2.8, 8.2.9, 9.0.0, 9.0.1, 9.0.2, 9.0.3, 7.3.9, 8.0.0, 8.0.1
Feedback submitted, thanks!