Adding Runbook Triggers

Runbook triggers are a set of conditions that when fulfilled trigger a run of a runbook.

With the main title section of the runbook selected, click +Add under Triggers in the right hand panel, as shown above.

A runbook trigger consists of a type and one or more conditions, as shown below.

A variety of types of runbook triggers are available, enabling the runbook to be triggered when an activity is created or updated, when an alert is received via a webhook, and when a runbook's state changes, as shown below.

Activity Creation Triggers#

These runbook triggers run any time an activity is created.

When you click the Conditions button after selecting "Activity creation", you can set conditions, as shown below.

  • Activity type. The runbook will trigger if the activity type matches.
  • Severity. The runbook will trigger if one or more severity levels match (SEV0, SEV1, SEV2, SEV3, SEV4, SEV5).
  • Originating webhook. The runbook will trigger if it originated from the specified incoming webhook.
  • Custom output params. If set, the runbook will trigger if the comparison made against a field in customOutputParams from the data parser is true. You must set a field (path within the JSON object), select a comparator (=, !=, >, >=, <, <=, or contains), and set a value to compare against. See Data parsers getting started for more info.

Activity Update Triggers#

As the name implies, these runbook triggers run any time an activity is updated.

When you click the Conditions button after selecting "Activity update", you can set conditions, as shown below.

  • Old or new activity type. If set, the runbook will trigger if the old or new activity type matches.
  • Old or new severity. If set, the runbook will trigger if any of the one or more old or new severity levels match (SEV0, SEV1, SEV2, SEV3, SEV4, SEV5)

Note: Each of these condition types will only match if the relevant activity trait changed in the update we’re looking at. For example, if you have these conditions set:

  • Old activity type = Task
  • New activity type = Incident
  • Old severity = SEV0

The trigger won’t fire if a SEV0 Task changes to be an Incident, the severity didn’t change, so the condition on old severity won’t be met.

Webhook Triggers#

As the name implies, these runbook triggers run any time the selected webhook fires.

  • Custom output params. If set, the runbook will trigger if the comparison made against a field in customOutputParams from the data parser is true. You must set a field (path within the JSON object), select a comparator (=, !=, >, >=, <, <=, or contains), and set a value to compare against. See Data parsers getting started for more info.

Runbooks Run State Triggers#

As the name implies, these runbook triggers run any time the state of the runbook's run changes, as shown below.

Next Steps#