Using placeholders

Placeholders are references to ticket and user data that you include in the subject and body of email notifications. Without them it would be impossible to create automated messages. For the complete list of placeholders, and where they can be used, see Zendesk Support placeholders reference.

This article contains the following sections:

• Using placeholders in business rules
• Using placeholders for custom fields
• Using placeholders for checkbox custom fields

Using placeholders in business rules

The placeholders are contained within matched double curly brackets and are, in the following example, references to ticket properties. If a placeholder references a field that does not have a value, then the placeholder will be blank in the automation, trigger, or macro.

Here’s an example of how placeholders are used in an email notification:

When you’re composing email notifications, you can view the list of placeholders by clicking View Available Placeholders.

For the complete list of placeholders, and where they can be used, see Zendesk Support placeholders reference. If you want more control on how placeholder data is selected and displayed, see Understanding Liquid markup.

When you apply a macro containing a placeholder to a ticket, the placeholder is evaluated according to what is currently true about the ticket. If the output of the evaluation returns any information, it is added as a ticket comment. For example, if a macro that returns the ticket ID is run on a ticket that has not been saved (and therefore has no ticket number yet), the ticket comments will not be updated. The macro is not re-evaluated when the ticket is saved. You could manually add the placeholder to the ticket using the placeholder {{ticket.id}}. This would allow it to be evaluated when you submit the ticket, and the value returned by the placeholder would be added to the ticket comments.

Using placeholders for custom fields

Placeholders are generated automatically, based on the ticket and current user properties. These are referred to as system placeholders.

When you add custom fields for tickets, users, or organizations, they are also available as placeholders. You can use placeholders for your custom fields as you would any other system placeholder.

Every custom field has a unique ID or key. When you create a custom ticket field, the ID is automatically generate for you. When you create a custom user or custom org field, you enter a unique key that cannot be edited once it is set.

Custom fields are not included in the list of available placeholders, but they follow this simple naming pattern that references their unique ID or key.

Ticket custom fields	{{ticket.ticket_field_<field ID number>}}
User custom fields	{{ticket.requester.custom_fields.<key_name>}}
Organization custom fields	{{ticket.organization.custom_fields.<key_name>}}

For example, a custom ticket field like this has the following placeholder:

{{ticket.ticket_field_505156}}

The placeholder name for the options in a custom drop-down list follows a different pattern. There's only one placeholder for all three drop-down list options because this is a reference to the option that was selected. The ID is for the custom drop-down list because options do not have IDs. Again, this is a reference to the single option that was selected.

Ticket custom drop-down fields	{{ticket.ticket_field_option_title_<field ID number>}}
User custom drop-down fields	{{ticket.requester.custom_fields.<field_key>.title}}
Organization custom drop-down fields	{{ticket.organization.custom_fields.<field_key>.title}}

Note: Take note of the syntax, as the placement of title in the placeholder varies, depending on the type of custom field.

For example, the placeholder for a drop-down list for a custom ticket field would look like this:

{{ticket.ticket_field_option_title_515416}}

To find the ID for a custom ticket field

1. Click the Admin icon () from the sidebar, then select Ticket Fields.
2. Locate your custom field in the list and then click Edit.

The ID is displayed in the right column:

To find the key for a custom user field or a custom organization field

1. Click the Admin icon () from the sidebar, then select User Fields or Organization Fields.
2. Click the name of a custom field.

   The field key appears in the properties panel on the right.

   

Using placeholders for a checkbox custom field

You can use placeholders in combination with Liquid markup to verify if a checkbox (custom field) has been selected on a ticket and provide customized output based on the checkbox status (checked, or not checked).

When you use Liquid markup if/else/case statements for checkbox custom ticket fields, remember that the checkbox field has a value of 0 or 1, not false or true. For example:

{% if ticket.ticket_field_<insert field_id here> contains 0 %}
checkbox is unchecked
{% else %}
checkbox is checked
{% endif %}