Status Update Templates

Customize and standardize your status updates

Status Update Templates simplify and standardize incident status communications. Free up time during incident response and keep stakeholders informed with consistent, detailed context.

📘

Availability

This feature is available on current Business, Enterprise for Incident Management, and Digital Operations (Legacy) plans. Contact the Sales Team if you want to upgrade to a plan that includes this feature.

🚧

Required User Permissions

Users with the following roles can create and edit Status Update Templates:

  • Manager
  • Global Admin
  • Account Owner

All users can use a Status Update Template during incident response.

Create a Template in the Web App

📘

Product Limit

You can add up to 500 templates to your account.

  1. Navigate to Incidents Status Update Templates.
  2. Click New Template.
  3. Enter a Name and an optional Description for the template.
  4. Click Create Template.
  5. In the Message template section, enter your desired text in the Message field. This is the text that will appear in push, email, and SMS status update notifications.
A screenshot of the PagerDuty web app showing the message template

Message template

  1. In the Email template section, enter a Subject and use the rich text editor to make any customizations to the default email status update notification in the *Body.
    Refer to the Fields in Email Notifications section for more information about including dynamic content in email status update notifications.
  2. Click Save.
    Before saving, you can click Preview in the top-right at any time to view how the message will appear in each notification channel.

Fields in Email Notifications

Email status update notifications can dynamically include information about the status update or incident. You can select standard fields and Custom Fields.

While editing the email status update notification's content in the rich text editor:

  1. In the Fields panel on the right, click to copy the field to your clipboard.
  2. Paste the field into the appropriate place in the email template.

The field appears in the email body between double curly braces, e.g., {{ status_update.message }}.

A screenshot of the PagerDuty web app showing the status update message field

Status update message field

The most common fields are listed by default; however, you can also enter a term to search for a more complete list of objects and their associated attributes. Refer to the FAQ below an exhaustive list of supported fields.

A screenshot of the PagerDuty web app showing where to search available fields

Search fields

Support for Liquid Templating Language

If you want to create conditional communications, Status Update Templates support the Liquid templating language across all configurable fields, including Message and email Subject and Body.

When referring to fields inside a Liquid tag, omit the double curly braces {{ ... }}. For example, the following snippet transforms the incident title to uppercase for incidents with a "P1" priority, and otherwise leaves it unchanged:

{% if incident.priority.name == "P1" %}
  {{ incident.title | upcase }}{% else %}{{ incident.title}}
{% endif %}

📘

Note

The following Liquid tags are not supported:

  • tablerow
  • liquid
  • echo
  • render
  • include

Fields with Multiple Values

Depending on where an incident is in its lifecycle, the following fields can contain more than one value (i.e., in an array):

  • Status Updates, incident.previous_status_updates
  • Impacted Business Services, incident.impacted_business_services
  • Impacted Technical Services, incident.impacted_services
  • Acknowledgements, incident.acknowledgements
  • Assignments, incident.assignments
  • Teams, incident.teams

Since these items are stored in an array, you might need to provide an index to access their properties' values. For example,{{incident.previous_status_updates[0].message}} displays the first status update associated with the incident.

Alternatively, use a for loop to display all values stored in an array. The following example iterates through all status updates associated with an incident:

{% for update in incident.previous_status_updates %}
  {{update.message}}
{% endfor %}

You can also access more than one of the properties associated with the update variable. For example, you can include a status update's time with the message:

{% for update in incident.previous_status_updates %}
  {{update.created_at}} — {{update.message}}
{% endfor %}

Additionally, you can display only the most recent status update and its creation time. Status updates are sorted by date and time in descending order, so you can use Liquid's first syntax to display only the most recent update:

{% assign update = incident.previous_status_updates | first %}
{{update.created_at}} — {{update.message}}

For more information, refer to the Liquid templating language's documentation.

Edit a Template in the Web App

  1. Navigate to Incidents Status Update Templates.
  2. Click Edit on the right of the template you want to edit.
  3. Edit the template as desired.
  4. Click Save.

Duplicate a Template in the Web App

  1. Navigate to Incidents Status Update Templates.
  2. Click Duplicate on the right of the template you want to duplicate.
  3. Enter a new name and description for the template.
  4. Click Duplicate Template.

Delete a Template in the Web App

  1. Navigate to Incidents Status Update Templates.
  2. Click Delete on the right of the template you want to delete.
  3. In the confirmation modal, click Delete. This action is irreversible and cannot be undone.

Use a Status Update Template During Incident Response

  1. Navigate to an incident's detail page.
  2. Select the Status Updates tab.
  3. Click New Update.
  4. Select a communication template from the dropdown.
  5. Click Preview.
  6. (Optional) If necessary, adjust the pre-populated text in the Message field.
    Note: Adjustments made in the Message field will also reflect in the email body.
A screenshot of the PagerDuty web app showing a preview of the message that will be sent to subscribed stakeholders

Status Update Template

  1. Click Send Message to notify incident subscribers.

🚧

Requirement

The email Subject has a maximum of 255 characters. A status update notification containing more than the maximum character length returns the following error message:

There is a problem with this template. Please report this problem to your account administrator.

If this occurs, you can click Edit Email to adjust the Subject.

FAQ

What is the full list of supported fields?

The following table details the full list of fields you can use in your status update templates:

CategoryFieldDescriptionExample Value
Incidentincident.created_atThe time the incident was created2022-10-06T21:30:42Z
incident.html_urlPagerDuty URL to this incidenthttps://subdomain.pagerduty.com/incidents/PT4KHLK
incident.idUnique ID of the incidentQ0U747RKFEV100
incident.incident_numberThe incident number1234
incident.last_status_change_atThe time of the last status change for this incident2022-08-15T16:57:40Z
incident.last_status_change_by.html_urlPagerDuty URL of the entity that made the last status change for this incidenthttps://subdomain.pagerduty.com/service-directory/PAW0B9L
incident.last_status_change_by.idThe ID of the entity that made the last status change for this incidentPAW0B9L
incident.last_status_change_by.summary The name of the entity that made the last status change for this incidentTechnical Service Name
incident.last_status_change_by.typeThe type of entity that made the last status change for this incidentservice_reference
incident.priority.nameThe priority of the incidentP2
incident.resolved_atThe time the incident was resolved2023-08-22T07:12:50Z
incident.statusThe status of the incidentacknowledged
incident.summaryShort description of the incident containing the incident number and title[#1234] The server is on fire.
incident.titleThe title of the incidentThe server is on fire.
incident.urgencyThe urgency of the incidenthigh
incident.linked_records.servicenow_itsm_incidents[0].idThe ID of the ServiceNow ITSM incidentINC1234567
incident.linked_records.servicenow_itsm_incidents[0].urlThe URL of the ServiceNow ITSM incidenthttps://subdomain.servicenow.com/incident.do?sys_id=INC1234567
incident.linked_records.servicenow_csm_cases[0].idThe ID of the ServiceNow CSM caseCS1234567
incident.linked_records.servicenow_csm_cases[0].urlThe URL of the ServiceNow CSM casehttps://subdomain.servicenow.com/csm_case.do?sys_id=CS1234567
incident.linked_records.jira_incidents[0].idThe unique identifier for the Jira incidentINC-1234
incident.linked_records.jira_incidents[0].urlThe URL of the Jira incidenthttps://subdomain.jira.com/browse/INC-1234
incident.linked_records.salesforce_cases[0].idThe unique identifier for the Salesforce caseCase #123456
incident.linked_records.salesforce_cases[0].urlThe URL of the Salesforce casehttps://subdomain.salesforce.com/incident.do?sys_id=Case%23123456
incident.linked_records.zendesk_tickets[0].idThe unique identifier for the Zendesk ticket1234567
incident.linked_records.zendesk_tickets[0].urlThe URL of the Zendesk tickethttps://subdomain.zendesk.com/agent/tickets/1234567
Acknowledgementincident.acknowledgements[X].acknowledger.html_urlPagerDuty URL of the acknowledgerhttps://subdomain.pagerduty.com/users/PXPGF42
incident.acknowledgements[X].acknowledger.summaryName of the acknowledgerEarline Greenholt
incident.acknowledgements[X].acknowledger.typeAcknowledger typeuser
incident.acknowledgements[X].atTime this acknowledger was added to the incident2022-08-18T14:28:44Z
Assignmentincident.assignments[X].assignee.html_urlPagerDuty URL of the assigneehttps://subdomain.pagerduty.com/users/PL0S7BA
incident.assignments[X].assignee.idThe ID of this assigneePL0S7BA
incident.assignments[X].assignee.summaryThe name of this assigneeEarline Greenholt
incident.assignments[X].assignee.typeAssignee typeuser_reference
incident.assignments[X].atTime this assignment was added to the incident2022-08-15T16:57:40Z
Communicationsincident.conference_bridge.conference_number*Conference bridge number to this incident+1-415-555-1212,,,,1234#
incident.conference_bridge.conference_url*Conference URL number to this incidenthttps://example.com/123-456-789
incident.slack_channel.nameSlack channel name to this incidentSlack Channel Name
incident.slack_channel.urlSlack channel URL to this incidenthttps://slack.com/app_redirect?channel=somechannel&team=someteam
Servicesincident.impacted_business_services[X].idThe ID of the impacted business servicePD1234
incident.impacted_business_services[X].summaryThe name of the impacted business serviceWeb API
incident.impacted_services[X].html_urlPagerDuty URL of the impacted technical servicehttps://subdomain.pagerduty.com/service-directory/PAW0B9L
incident.impacted_services[X].idThe ID of the impacted technical servicePAW0B9L
incident.impacted_services[X].summaryThe name of the impacted technical serviceTechnical Service Name
incident.service.html_urlPagerDuty URL of the technical service that belongs to this incidenthttps://subdomain.pagerduty.com/service-directory/PAW0B9L
incident.service.idPagerDuty ID of the technical service that belongs to this incidentPAW0B9L
incident.service.summaryThe name of the technical service that belongs to this incidentTechnical Service Name
Teamsincident.teams[X].html_urlPagerDuty URL of the Team that belongs to this incidenthttps://subdomain.pagerduty.com/teams/PP2R1SK
incident.teams[X].idThe Team ID that belongs to this incidentPP2R1SK
incident.teams[X].summaryThe name of the Team that belongs to this incidentBilling Support
Status Updateincident.previous_status_updates[X].created_atThe time this status update was created2022-08-20T07:40:48Z
incident.previous_status_updates[X].idThe ID of this status updatePX69SY8
incident.previous_status_updates[X].messageThe message of this status updateThe team is still investigating the issue.
incident.previous_status_updates[X].sender.html_urlPagerDuty URL of the user that created this status updatehttps://subdomain.pagerduty.com/users/PXPGF42
incident.previous_status_updates[X].sender.idThe unique ID of the user that created this status updatePXPGF42
incident.previous_status_updates[X].sender.summaryThe name of the user that created this status updateEarline Greenholt
incident.previous_status_updates[X].sender.typeSender type of this status updateuser_reference
sender.descriptionProfile description of the user sending the status updateSupport Engineer
sender.emailThe email of the user sending the status update[email protected]
sender.html_urlURL to the user sending the status updatehttps://subdomain.pagerduty.com/users/PXPGF42
sender.nameThe name of the user sending the status updateEarline Greenholt
status_update.created_atThe time the status update is created2015-10-06T21:30:42Z
status_update.messageThe message entered by a responder when creating a status updateThe team is still investigating the outage.
status_update.status_dashboard_urlURL to the status dashboard for this incidenthttps://subdomain.pagerduty.com/status-dashboard/incidents/Q0U747RKFEV100

* If an incident has its own conference bridge, this value is shown. If not, and the conference bridge is configured at the service level, the service-level conference bridge information is displayed. If no conference bridge information is available, this value is empty.

† This field may contain more than one value. Refer to the Fields with Multiple Values section above for tips on using the Liquid templating language to display multiple values.

📘

Custom Fields

Status Update Templates support Custom Fields. You can search for Custom Fields using their Field Name, or you can find them in the Incident section.