Adding Runbook Actions

Actions are runbook operations that push, pull, and put data leveraging Transposit's library of integration APIs.

For example, actions can start an automated process, reboot a server, or ask a question.

When you are creating a runbook, you can add actions when the runbook starts, within its body, and when a runbook succeeds or fails, as shown below.

As you can see above, the action-related elements of a runbook are:

  • Sections. Use these to organize actions that relate to each other.
  • Buttons. Use these to provide human interaction when the runbook is run.
  • Actions. Use these to define the processes handled by the runbook.

Follow the steps below when you are adding and organizing the actions in your runbooks.

  1. Configure Integrations
  2. Add Chained Actions
  3. Add Humans in the Loop
  4. Add Dynamic Templates
    1. Activity Templates
    2. Action Templates
    3. Runbook Template

1. Configure Integrations#

When an action is run, a connection can automatically be made to an application, so that data can be pulled from and pushed to it.

For each step in your runbook, click +Add action to select the application with which you'd like data to interact, as shown below.

When you have selected an application, go to Settings > Integrations to configure the integration between the application and Transposit.

For example, if you select "Create a Zoom meeting" in the dialog above, as shown below...

...make sure to go to Settings > Integrations to configure the authorization settings needed by Transposit to interact with Zoom in the actions where you will be interacting with Zoom, as shown below.

Note:

  • The authorization set as Team Authorization is used by actions run by any member of the team, unless the action is configured to use User Authentication instead.
  • When an action is run via a trigger, no user is associated with it, and therefore the action will fail if it requires User Authorization.
  • Do not add actions that require User Authorization in the start step of your runbook because that part of the runbook will always be run automatically and never explicitly by the user who has authorization for the action.

2. Add Chained Actions#

If actions relate to each other, you can chain them together, so that they are executed in sequence within a single process.

Below, you see two actions that will run sequentially because they are chained in the same section within the body of a runbook.

Note: Output of one action can be used as the input of another action, see Action Templates for details.

3. Add Humans in the Loop#

For each parameter made available by the action, you can specify whether the person who executes the runbook should be prompted for input when the runbook is run.

As shown below, you can check the Prompt for user input checkbox for each parameter, depending on whether user input will be required or whether you will define the applicable data now while defining the runbook.

4. Add Dynamic Templates#

Use the Data buttons to set text or specify templates that will provide the applicable data for each parameter required by the action.

For example, you can use a template to refer to the output of a previous action, as shown below, where the parameters of a Zoom action are populated by the output of a Jira action.

As seen above, you can define templates in action inputs to be filled by the output of a related activity, action, or runbook, as shown below.

  • {{Activity.commander}}
  • {{Action.Inputs.transposit_create_linked_jira.summary}}
  • {{Runbook.created_at}}

You do not need to know the template syntax because the templates are generated for you when you click Data, as shown below.

For each type of template, the available values that can be selected when you are defining your actions are outlined below.

Activity Templates#

To create a template that uses information from the activity that contains the runbook providing the action, select Activity and then choose the relevant activity field, as shown below.

Some activity fields available for your templates are as follows.

  • created_at: activity creation date and time
  • description: the activity’s description
  • name: the activity’s name
  • public_id: the activity’s ID
  • type: the activity’s type (INCIDENT, TASK, etc.)

Action Templates#

Output of one action can be used as the input of another action.

For example, you may want to implement an incident response process that uses a unique ticket number created in Jira to tie together communication channels, such as via Slack and Zoom, and to escalate issues to engineers and the operations team, all with the context available in the originating ticket.

Choose the previous action to provide the input of the parameter in the action you're defining, as shown below.

Within the selected previous action, select the parameter that will provide the input to the parameter you're defining, as shown below.

Runbook Templates#

To create a template that uses information from the runbook that contains the action, select Runbook and then choose the relevant field, as shown below.

Some runbook fields available for your templates are as follows.

  • created_at: run creation date and time
  • id: runbook id in the format "team:name/version"
  • name: runbook name
  • pretty_name: runbook pretty name
  • run_id: runbook run ID (a UUID)
  • source: "AUTO" or "MANUAL"
  • state: "IN_PROGRESS", "DONE", or "ERROR"
  • team: the team that owns the runbook
  • version: the runbook’s version

Next Steps#