Using template variables in Runbook steps

FireHydrant lets you include incident data in Runbook steps, such as Slack channel notifications and email notifications.

We use the Liquid template language to enable interpolation of variables into your messages. In addition to being able to control the content of the message, you can also format it using Markdown syntax.

Available variables and example values

incident.id: 2a73ba58-1c13-489e-9200-b3993e1dcb60
incident.name: Service x failure rate is 10%
incident.created_at: 2019-09-10T18:49:50.549Z
incident.summary: Support noticed an increase in tickets from customers about calls to service x failing
incident.description:
incident.current_milestone: acknowledged
incident.number: 12
incident.severity: SEV1
incident.severity_impact: some
incident.severity_condition: unavailable
incident.active: true
incident.labels: {"my_label": "my_value"}
incident.incident_url: https://app.firehydrant.io/incidents/2a73ba58-1c13-489e-9200-b3993e1dcb60/incident/overview
incident.private_status_page_url: https://app.firehydrant.io/incidents/internal/status-page/7e50a7f7-facd-4e39-b2f3-babec9548fc5/a0b0c0d0...
incident.organization.name: FireHydrant, Inc
incident.last_update: "This is the most recent note added."
incident.report_id: 557eeeec-6a4f-443d-8e1a-db6c3f2a8be5

Note: When incidents are created, you may not have services, environments or roles assigned yet. We recommend that you disable automatic execution of a step if you include this information in the notification.

Usage examples

Notify your team of incidents upon declaration



Create complex list of roles and impacted services


### #{{ incident.severity }}: #{{ incident.name }}

---

##### Summary

#{{ incident.summary }}

---

##### Description

#{{ incident.description }}

---

##### Impact

{% if incident.environments != empty %}

Environments:

{% for environment in incident.environments %}

* #{{ environment.name }}

{% endfor %}

{% endif %}

{% if incident.services != empty %}

Services:

{% for service in incident.services %}

* #{{ service.name }}

{% endfor %}

{% endif %}

{% if incident.functionalities != empty %}

Functionalities:

{% for functionality in incident.functionalities %}

* #{{ functionality.name }}

{% endfor %}

{% endif %}

---

##### Labels

{% for label in incident.labels %}

**#{{ label[0] }}:** #{{ label[1] }}

{% endfor %}

---

##### Roles:

{% for role in incident.role_assignments %}

{% if role.status == "active" %}

#{{ role.incident_role.name }}: #{{ role.user.name }}

{% endif %}

{% endfor %}

---

[View Status Page](#{{ incident.private_status_page_url }})
Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more
Register your product
You can get support that’s tailored to you, owner exclusives and more
Our helpline hours:
8:00am - 8:00pm CST Monday to Friday; 9:00am - 6:00pm CST Saturday
Follow us on Twitter
Get the latest news and updates first