Skip to main content

Email template variables

Purpose

This table lists the variables the platform fills in automatically for each email template type — the data each variable carries, such as a link to the affected object or the user who triggered an action, and which templates it applies to. Use it when customizing a template to know what's available to display.

Available variables

Variable

Available templates (readable names)

Explainer

baseUrl

All templates

Base Process Design URL for building links

browserUrl

All standard notifications:

Approved Version Change Email
Approval Cycle Started Email
Approval Cycle Finalized Email
Approval Cycle Rejected Email
Approval Cycle Canceled Email
Endorsement Cycle Started Email
Endorsement Cycle Finalized Email
Endorsement Cycle Canceled Email
Review Cycle Started Email
Review Cycle Finalized Email
Review Cycle Canceled Email
Checkin Email
Commented Email
Comment Resolved Email
Comment Reopened Email
Comment Deleted Email
Acknowledgement Cycle Started Email
Acknowledgement Cycle Paused Email
Acknowledgement Cycle Resumed Email
Acknowledgement Cycle Canceled Email
Attention Needed Email
Multiple Cycle Reminders Email

Deep link to the relevant page for the event associated with the email. It always resolves to the affected object itself — you can't append a path such as /Login to it.

object.id
object.name

All standard notifications

Name and ID of the repository object associated with the event.

repository.shortname
repository.name

All standard notifications

Repository shortname or name in which the relevant object is present

themeColors.primary
themeColors.secondary
themeColors.accent

All templates

Brand/tenant colors to style the email.

isRequiredWatcher

All standard notifications

Whether the watcher is marked “required.”

useLocale

All standard notifications

Best content/UI locale chosen per recipient.

universityUrl

All templates

Link to iGrafx University

annotation

Commented Email
Comment Resolved Email
Comment Reopened Email
Comment Deleted Email

Annotation/comment text.

pausedCycleComment

Checkin Email; Acknowledgement Cycle Paused Email

Reason/details when paused (or on check-in).

resumedCycleComment

Acknowledgement Cycle Resumed Email

Reason/details when an acknowledgement resumes.

triggeringUser

Review Cycle Started Email
Approval Cycle Started Email
Endorsement Cycle Started Email
Acknowledgement Cycle Started Email
Attention Needed Email
Acknowledgement Cycle Resumed Email
Approval Cycle Canceled Email
Review Cycle Canceled Email
Endorsement Cycle Canceled Email
Acknowledgement Cycle Canceled Email
Commented Email; Comment Resolved Email
Comment Reopened Email
Comment Deleted Email
Checkin Email
Acknowledgement Cycle Paused Email

Display name of the user who initiated the event.

startCycleComment

Review Cycle Started Email
Approval Cycle Started Email
Endorsement Cycle Started Email
Acknowledgement Cycle Started Email
Attention Needed Email
Acknowledgement Cycle Resumed Email

Kickoff note/comment when a cycle starts/resumes or attention is requested.

cancelCycleComment

Approval Cycle Canceled Email
Review Cycle Canceled Email
Endorsement Cycle Canceled Email
Acknowledgement Cycle Canceled Email

Reason provided when a cycle is canceled or a comment state changes.

version

Approved Version Change Email
Approval Cycle Finalized Email

Specific version number relevant to the approval-change notice/cycle completion.

numberOfUpdates

Attention Needed Email

Count of cycles the user was added to

clientLink

All standard notifications (only when object type is Flowcharter Document/Diagram)

Direct Flowcharter Client link to open the document or object.

dueDate

Acknowledgement Cycle Started Email

Recipient-localized due date string (or “to be determined”).

isOverDue

Acknowledgement Cycle Started Email

true if current time is after dueDate.