Notification templates

This feature enables you to customize your notifications with dynamic content using OlivLang. You can personalize the sender details, subject, and message content (both text and HTML versions) for each template to better reflect your brand and communication style.

Feature is accessible under Global Settings → Messages

Customization Options

Activate/Deactivate Customization:
Turn on or off customization for each notification type.
Editable Fields:
- From: Define the sender's name and email (e.g., Sender Name <sender@example.com>).
- Subject: Set the email subject line.
- Text Message: Write or edit the plain text version.
- HTML Message: Write or edit the rich text (HTML) version.
Restore Defaults:
Each field has an option to revert to its default value if you need to reset your changes.

Template customization window

Enhancing Templates with OlivLang

OlivLang is a powerful templating language that allows you to add dynamic elements to your emails. Below are some examples demonstrating its capabilities.

1. Interpolation

Insert dynamic values into your templates by wrapping variable names in double curly braces.

Hello {{ variable }}.

2. Conditionals

Display content based on certain conditions.

{{ if (condition) }}
{{ else }}
    {{ if (anotherCondition) }}
    {{ else }}
    {{ end }}
{{ end }}

3. Loops

Iterate over a collection to dynamically list items.

{{ for (var item of collection) }}
{{ end }}

4. Functions

Create and use custom functions to format or manipulate data.

{{ fun display(line) }}
    --- {{ line }} ---
{{ end }}

5. Accessing nested fields

Use dot notation to access nested properties.

{{ issue.fields.summary }}

6. Comments

Add internal messages that will not collude with the template.

{{ // Hello }}

Dynamic Data Placeholders

In addition to using OlivLang code, your email templates can include dynamic placeholders that are automatically replaced when the email is sent.

Sender Information:
${senderEmail}
User who started approval:
${approvalOriginator}
Approval properties:
All approval fields can be found in our API documentation.
Page fields:
All page properties can be found here in the Atlassian docs.
Atlassian docs containing all PageSingle fields under Responses section
Link to approval:
${approvalLink}
Application name:
${appName}
Optional fields:
${delegatorName} and ${action} (approval/consent) if available

Example OlivLang code

{{ // Example helper method to display some basic step fields }}
{{ fun displayStep(step) }}
    Step: {{ step.displayName }}
    - Type: {{ step.type }}
    - Status: {{ step.status }}
    - Decision date: {{ step.decisionDate }}
{{ end }}
{{}}Hello, {{ approvalOriginator }}!
Sender: {{ senderName }} ({{ senderEmail }})
Logo: <img src="{{ imageLogo }}" alt="Company logo"/>

Approval data:
Name: {{ approval.name }}
Status: {{ approval.status }}

Steps details:

{{ for (var step of approval.steps) }}
    {{ displayStep(step) }}
    {{ // Let's display more step fields conditionally }}
    {{ if (step.type == "USER") }}
    - User ID: {{ step.userId }}

    {{ end }}
{{ end }}

Page data:
Title: {{ page.title }}
Space ID: {{ page.spaceId }}
Status: {{ page.status }}

{{ if (approval.status == "SUCCESS") }}
  Approved
{{ else }}
  {{ if (approval.status == "IN_PROGRESS") }}
    In progress
  {{ else }}
    Rejected
  {{ end }}
{{ end }}

Testing Your Templates

A dedicated testing area allows you to preview the rendered output of your templates. Simply select the field you want to test (From, Subject, Text Message, or HTML Message), supply the necessary context, and view the results. If an error occurs during rendering, an error message will guide you through troubleshooting.

Successfully rendered template

Rendering error with the message