Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To create a new template, click Create or copy an existing out-of-box template or another custom template for an event. 

...

Info

Code Editor

For more details on using the code editors on this page for Email Subject and Email Body, see Working with the Code Editor


Field

Description

Template Name

The name of the template.

Events

Associate an event for the template (e.g. Workflow Request Completed). You can also assign more than one event to the same template.

Email Subject

The script to be used for email subject for the event(s).

Email Body

The script to be used for email body for the event(s).

Payload

The payload is used in the code editor to give suggestions of what variables and methods are available when accessing the $payload variable, as this will vary depending on the event. If more than one event is associated to this template, use this to switch between the selected events.

...

Both Subject and Body will be able to reference the payload object related to an event. Using the shortcuts, you will be able to access all the data associated to an event using the variable $payload. The below table shows the events and associate payload objects.

Events

Payload Object Name

Workflow Request Scheduled
Workflow Request Rejected
Workflow Request Deploying
Workflow Request Completed
Workflow Request Failed

NotifProjectWorkflowRequest

Folder Request Scheduled
Folder Request Rejected
Folder Request Deploying
Folder Request Completed
Folder Request Failed

NotifApplicationRequest

Workflow Request Pending Approval
Workflow Approval Assigned

NotifProjectTask

Workflow Request Pending Approval
Workflow Predeploy Pending Review Workflow Predeploy Review Rejected

NotifProjectReviewTask

Folder Request Pending Approval
Folder Approval Assigned

NotifApplicationTask

Pipeline Gate Approval Assigned

NotifPipelineGateTask

Pipeline Manual Step Assigned

NotifPipelineStepTask

Pipeline Step Exec Failed

NotifPipelineStepExectionRequest

...