Playbook parameters

Parameter ID

Description

name

Playbook name. Specified by the system when creating or updating a playbook. If the value is set in the algorithm, it will be replaced by the system.

description

Playbook description. Specified by the system when creating or updating a playbook. If the value is set in the algorithm, it will be replaced by the system.

version

Playbook version. The minimum length is 1.

This parameter is required.

dslSpecVersion

DSL schema version. The minimum length is 1.

This parameter is required.

responseActionsSpecVersion

Response actions schema version. The minimum length is 1.

This parameter is required.

playbookRunTimeout

The maximum execution time of the playbook, including waiting in the queue. The maximum value is 48 hours (48h). You can configure the maximum execution time in hours (h) and/or minutes (m).

By default, the value is 24h.

inputType

Inbound object type. The possible values: alert or incident. The inbound object type is specified by the system when creating or updating a playbook. If the value is set in the algorithm, it will be replaced by the system.

input

A jq expression that could be used to transform or filter incoming data before executing a playbook.

output

A jq expression that could be used to modify the output of the playbook before execution.

timeouts

Timeout definitions.

executionFlow

Steps of the playbook execution.

This parameter is required.