Runbook & action triggers

Transposit runbooks have two types of triggers: Runbook and action triggers. Runbook triggers are a set of conditions that when fulfilled trigger a run of a runbook, including any action triggers that are set to run. Let's break down your trigger options!

Action triggers #

There are two types of action triggers. Use action triggers to specify conditions for automatically running an action.

On runbook start #

An action with the "on runbook start" condition will run when the runbook is manually or automatically triggered.

On action completed #

An action with the "on action completed" condition will run when the selected action in the same runbook completes.

Runbook triggers #

There are three types of runbook triggers. Use runbook triggers to specify conditions for automatically running a runbook.

Incident or task creation #

Like the name implies, these runbook triggers run any time an incident or task is created in Transposit. There are a few additional conditions you can set:

Severity:
If set, the runbook will trigger if one or more severity levels match (SEV0, SEV1, SEV2, SEV3, SEV4, SEV5)

Originating webhook:
If set, the runbook will trigger if it originated from the specified incoming webhook.

Metadata:
If set, the runbook will trigger if in the metadata from the incoming webhook the comparison is true. You must set a field (path within metadata JSON object), select a comparator (=, !=, >, >=, <, <=, or contains), and set a value to compare against. See on metadata for more info.

Incident or task update #

Like the name implies, these runbook triggers run any time an incident or task is updated in Transposit. There are a few additional conditions you can set:

Old or new activity type:
If set, the runbook will trigger if the old or new activity type (Incident or Task) 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 #

Like the name implies, these runbook triggers run any time the selected webhook fires. There is only one condition you can set:

Metadata:
If set, the runbook will trigger if in the metadata from the webhook the comparison is true. You must set a field (path within metadata JSON object), select a comparator (=, !=, >, >=, <, <=, or contains), and set a value to compare against. See on metadata for more info.

On metadata #

The metadata in conditions is webhook-specific metadata that can be passed from the underlying integrator (the application you selected when setting up the webhook). The metadata comes through as a nested JSON object, and the conditions can specify a field (nested path from the top level of that JSON object), a comparator (=, !=, >, >=, <, <=, or contains), and a value to compare against.

Integrators built by Transposit all pass the original HTTP request body through this metadata (as a top level parsed_body field), so users should be able to set a condition on any field that was in the request to the Transposit from the external service (E.g. PagerDuty, OpsGenie, Jenkins, etc.)

For example, you could have a metadata condition like parsed_body.alert_name contains 500_error, where alert_name is data that the external service sent in the request.

If you need help with accessing the right information in the metadata, we'd be happy to help you at support@transposit.com. Most external services document their respective webhooks, but we understand it can be tricky to wade through this data.