Special Variables

Warning

The incidents special variable is deprecated and will be removed in v4.0.0

IMPulse supports special variables you can use in some impulse.yml places and in templates:

  • childs - map of uniq_ids to incident objects this incident inhibits (see inhibition)
  • env - to access environment variables (see example)
  • groups - map of messenger.groups (see API /api/groups)
  • incident - to access current incident fields (see API /api/incidents)
  • incidents - incidents store (incidents.uniq_ids is the uniq_id → incident map). Deprecated, use parents / childs instead
  • parents - map of uniq_ids to incident objects that inhibit this incident (see inhibition)
  • payload - to access the most recent alert payload (the payload variable refers to incident.payload)
  • previous_payload - to access the alert payload before the latest update
  • step - the chain step being executed. Same format as step in incident.chain_steps (see API /api/incidents)
  • ui_user - the authenticated UI user who triggered the action, if any
  • user_groups - map of user groups (see API /api/user_groups; users: /api/users)
  • users - map of users (see API /api/users)
  • webhooks - map of webhooks (see API /api/webhooks)