Playbook algorithm

May 15, 2024

ID 267548

The playbook algorithm is the sequence of steps and response actions to alerts or incidents, specified in the JSON format. You can specify the playbook algorithm when creating or editing a playbook.

This section contains information about the parameters that you can use to create the playbook algorithm.

There are three types of playbook data:

  • Global data.

    Global data is readable at any step of the playbook. Global data contains information about the alert or incident for which the playbook was launched.

    You cannot edit global data by using a playbook, or by changing alert or incident data. Global data remains unchanged for the entire lifetime of the playbook instance.

  • Operational data.

    Operational data is transferred between the steps of the playbook. You can manage operational data by using jq expressions, which are specified in the input and output parameters.

  • Local data.

    Local data is limited to a specific step. You can manage local data by using the input (local data generation) and output (generation of operational data from local data) parameters.

In this section

Playbook parameters

Execution step parameters

ResponseFunction parameters

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.