Webpush inserts

Common tags used in webpush messages

You can use all tags from Insert usage.

TIP: 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

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.

TIP: 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.

IMPORTANT: Percent-encode any special characters in the URL before you add the link to the message. For example, encode a space as %20. Encoding is your responsibility as the sender; Synerise doesn't encode links for you. For the encoding rules, see RFC 3986: Uniform Resource Identifier (URI): Generic Syntax.

Usage

Use absolute URLs that include the scheme, for example https://example.com/promo. Relative links (such as /promo) and protocol-relative links (such as //example.com) aren't supported:

  • In the HTML of an email, the campaign can't be saved. The error message lists the invalid links.
  • Inside preparelink, the tag generates a link that doesn't work.

In the HTML of an email, Synerise leaves the following links unchanged: anchors (such as href="#" or href="#section"), empty values (href=""), and mailto: and tel: links. It doesn't add parameters or a redirect to them, and it doesn't track clicks on them. Don't put these values inside preparelink. Anchors become a redirect that doesn't work, and mailto: and tel: links make the message fail to render, so it gets the notSent status.

  • 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 = "https://example.com/" %}
      <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="https://example.com/">Link text</a>
  • Mobile push and SMS:

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

Example of the destination URL after the redirect, with the parameters added:

https://example.com/?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_ws=0f8e2c4a-3b1d-4e6f-9a7c-5d2b8e1f4a6c&snrs_redir=1

WhatsApp Partner integration: skipDomain variant

The WhatsApp Partner integration requires a special variant of the tag:

{% preparelink skipDomain=true %} YOUR_URL {% endpreparelink %}

As with the standard tag, use an absolute URL.

The skipDomain=true parameter instructs Synerise to skip prepending the redirect domain to the link. This is necessary because in the WhatsApp Partner integration, the redirect domain is configured directly in Meta, and Synerise only appends the tracking parameters to the URL you provide. Without this flag, the default redirect domain would be added, which would break the link.

IMPORTANT: This variant works only in the "Send Template Message" node. Using skipDomain=true in any other channel (email, SMS, mobile push) will not produce the expected result.

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 - 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.
    IMPORTANT: - 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.

Using inserts in webpush messages

Inserts can be used in all fields of the webpush definition.

In the URL, Icon, and Image fields, if any jinjava is used, the following tag must be added at the end of the code of the field:

{%- if false -%} withoutRedirect=1 {%- endif -%}
Adding jinjava to URL, Icon, or Image
Adding jinjava to URL, Icon, or Image

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