Dynamic Parameters

The Dynamic Parameters feature allows you to include templates in environment variables that will be filled in from properties of the runbook run or the activity associated with it. These templates will be filled in for both input prompts and action executions.

How to use:#

To use this feature, you will use the template form of {{Namespace.template}}, where Namespace is currently either "Activity" or "Runbook", and template is the name of a supported activity or runbook field. You may include one or more templates; for example, you could use TR-{{Activity.public_id}} {{Runbook.pretty_name}}. If the activity ID is 56 and the runbook’s pretty name is "My Runbook", when the action’s dev platform app looks up the environment variable, it will get "TR-56 My Runbook".

If a template does not correspond to a value due to it being invalid or the field is empty, the template is left unexpanded.

Supported templates:#

Activity:#

  • 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.)

In addition, all user-defined custom activity fields are supported. For example, if an activity has a field called "special_id", it can be requested with the template {{Activity.special_id}}.

Runbook:#

  • 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