Notification Templates

Changing the default Veza reminder emails and notifications.

You can use the Notification Templates API to customize the subject and body contents of emails triggered by Access Reviews events, such as notifications when reviewers are reassigned, and reminders as a review due date approaches.

Emails can trigger based on actions, deadlines, and review states (mapped to the template's usage). You can customize a template for each usage, such as when a reviewer is re-assigned, or for inactivity reminders. Each usage can have a single custom template.

This document describes the notification types that support custom templates, and the placeholders and default messages for each. See for API operations and examples.

Templates support HTML and CSS. To use images in an email template, you can add small files as attachments, or reference an image hosted elsewhere
Each reminder and Orchestration Action enabled in a review configuration will trigger independently.
Templates for each notification type can use placeholders to include snippets of text and variables.
The template is not validated upon submission. Use the operation to ensure that placeholders and attachments are rendering as expected for each usage.

Example request body for adding a template:

Custom domains for email notifications By default, emails from Veza originate from noreply@vezacloud.com. The Veza support team can help you change this to a domain for your organization. To enable a custom domain, you will need to provide Veza with credentials for a user account with permission to send email and an email relay Veza can authenticate to.

Default notifications and usage

The built-in template for all messages uses a {{WORKFLOW_TEXT}} placeholder, representing an email body that depends on the usage.

Built-in template

The template following template applies for all notifications unless a custom template exists for the usage.

{{WORKFLOW_TEXT}} is a placeholder for default text, which varies based on the usage.
{{WORKFLOW_TIME}} is the time in GMT

Note that depending on how you are submitting your request, you may have to escape any double quotes " in your HTML templates for JSON compatibility, for example:

Attachments: Small images under 64kb can be included as attachments within the template. To embed high-resolution images in your templates, you should serve the content from a publicly available location, and use HTML to link and style it. Attachments must be base64-encoded and specified in the attachments field of the API request. To use an attachment in a template, specify it by attachment.name, for example:

Placeholders

Use placeholders to include dynamic information in templates, such as decision timestamps, reviewer names, and other review or configuration metadata. Some placeholders are available depending on the template usage, and some are available for all templates, such as {{WORKFLOW_NAME}} and {{WORKFLOW_URL}}.

Placeholders for all templates

If a review (certification) exists for a configuration (workflow), the following placeholders are available:

Dates and Times: For placeholders that refer to a timestamp, you can show the full "Time" or simple "Date" format:

{{WORKFLOW_CERT_STARTED_ON_TIME}} result: "Mon, Jan 2nd 2006, 3:04:05PM"
{{WORKFLOW_CERT_STARTED_ON_DATE}} result: "2006-01-02"

ACCESS_WORKFLOW_OWNER_CHANGED placeholders

ACCESS_WORKFLOW_REMINDER_NO_ACTIVITY placeholders

ACCESS_WORKFLOW_REMINDER placeholders

ACCESS_WORKFLOW_REVIEWER_CHANGED placeholders

Placeholders: Rejected and Accepted Rows

Usages ACCESS_WORKFLOW_ROW_ACCEPTED_AND_SIGNEDOFF and ACCESS_WORKFLOW_ROW_REJECTED_AND_SIGNEDOFF have unique placeholders:

Examples

Number of impacted rows:

List of approved or rejected rows:

List of approved or rejected rows, including notes:

When including notes, rows approved or rejected without a note will fall back to:

Placeholders: Phrases

Some placeholders represent a collection of strings and variables and are used to construct the default messages:

PreviousSystem Events NextNotification Templates API

Last updated 3 months ago