Email inserts

Common tags available in email communication

You can use all tags from Insert usage.

If you use Visual Studio Code as your editor, you can use code snippets to speed up working with inserts.
You can find the snippets in our Github repository: https://github.com/Synerise/jinja-code-snippet

Opening a message in the browser

You can generate a URL that opens the message in a browser.

{{ synerise-open-in-browser }}

The URL is generated as plain text. If you want it to display as a hyperlink, add HTML, for example:

<a href="{{ synerise-open-in-browser }}">Click to open the message in a browser</a>

Adding a resignation link

You can generate a URL that revokes the customer's email communication agreement.

{{ synerise-resign-link }}

The URL is generated as plain text. If you want it to display as a hyperlink, add HTML, for example:

<a href="{{ synerise-resign-link }}">Unsubscribe</a>

Adding UTM and tracking parameters to links

If the message includes links, you automatically add parameters (such as UTM) and track click events by using {% preparelink %}{% endpreparelink %}. This will generate a redirect URL based on the hosting environment of your workspace:

If your workspace is hosted on:

  • Microsoft Azure EU, the default domain redirect URL is link.snrs.it,
  • Microsoft Azure USA, the default domain redirect URL is link.azu.snrs.it
  • Google Cloud, the default domain redirect URL is link.geb.snrs.it.
    On the user interface in the Synerise platform, you can configure how the end user's identifier (UUID) is handled when a link contains end-user identifying parameters (snrs_cl and snrs_he); for detailed instructions, see the "Managing user context" section.

Configuring a custom domain for redirect URL

If you have already set up a custom domain (for example, for first-party tracking), you can use it immediately without any additional configuration; simply contact Synerise Support for assistance. Otherwise, to set up a custom domain for the redirect URL, meet the following requirements:

  • If you want to provide your own certificate:1. Prepare an X.509-format certificate. 2. Deliver the following files to Synerise Support:
    - private key (key.pem) - Fullchain certificate (fullchain.pem):
    - The leaf certificate must be the first in the file. - Intermediate certificates must follow, from the lowest-level to the highest. - Do not include the root CA.

    • When you use your own certificate, it is your responsibility to monitor its expiration time and re-generate it. - Ensure that the fullchain.pem file is complete. Missing certificates or wrong certificate order may cause SSL/TLS errors.
  • Send the SSL certificate to Synerise Support or give an approval for generating a certificate through Let's Encrypt.
  • Configure DNS - add the CNAME record. Depending on the cloud where your workspace is hosted:

    • for Microsoft Azure EU, set the CNAME to: link.snrs.it
    • for Microsoft Azure USA, set the CNAME to: link.azu.snrs.it
    • for Google Cloud Platform, set the CNAME to: link.geb.snrs.it
  • Submit a customer service request for configuring your domain in Synerise.

Preview in messages

If you use a custom redirect URL, the links in the message preview still use the default domain. The custom domain is applied while sending the messages to customers.

Usage

  • Emails:

    • If your link is stored as a Jinja variable and then used as a variable in the HTML, you must use a preparelink tag to generate a link with the parameters:

      {% set a = "/" %}
      <a href="{% preparelink %}{{a}}{% endpreparelink %}">Link text</a>
    • If the link is defined in the template as plain HTML, the parameters and tracking are added automatically when parsing the HTML. You don't need to use the insert:
      <a href="">Link text</a>
  • Mobile push and SMS:

    <pre><code class="language-jinja">{% preparelink %}YOUR_URL{% endpreparelink %}</code></pre>
    

Example of a parsed link:

/?snrs_medium=email&snrs_action=newsletter.click&snrs_test=false&snrs_var=4715029&snrs_cp=6b716f86-a14d-4b8c-8795-872f7432a046&snrs_cl=b5d8c721-c2b7-42ac-9cd5-7714dedf73bf&snrs_category=client._DEVICE_.browser.mail&snrs_he=1940871749&snrs_redir=1

Validation

Whenever you use Jinjava in email communication, verify that it displays correctly for a few different test customers to make sure that the logic you applied covers all scenarios. If Jinjava fails to render, the communication is not sent to a customer at all.

If the sending failed, a message.notSent event is saved to the customer's profile, with additional information in the extra property. This works both for test emails and already launched communications.

If a tag is not opened/closed properly it is treated as plain text and does not cause an error.
Example: Missing } in {{ synerise-resign-link }

In the following example, a typo (missing w letter) when calling synerise-open-in-browser tag caused a wrong interpretation of the tag and a rendering failure.

{
    "action": "message.notSent",
    "eventUUID": "e0096c9d-8abc-4c4e-b75f-efa3c56934b0",
    "createDate": 1620912890658,
    "label": "dfbbb5f6-abf6-4c79-87db-f893359ffa5d",
    "params": {
        "clientId": 1382495929,
        "auth.internal": false,
        "info": "rendering failed",
        "testDelivery": true,
        "id": "dfbbb5f6-abf6-4c79-87db-f893359ffa5d",
        "campaignName": "Test",
        "extra": "Missing synerise-open-in-broser value",
        "time": 1620912890658,
        "title": "Test"
    }
}

Canonical URL: https://hub.synerise.com/developers/inserts/email