Webhook - Send Custom Request - Trimou Templating Engine Guide

Prerequisites

• Webhook - Action Parameters
• Webhook - Template Variables Guide

Overview

Trimou is an open-source templating engine that allows the rendering of documents based on JSON input and a template definition. This guide explains common syntax, as well as extensions which are custom to Tealium AudienceStream.

For more, see: Trimou 2.3.0 Documentation

Webhooks

When setting up a webhook in AudienceStream, a vistor profile has visitor and visit attributes that need to be mapped to the required output. A visitor profile example that shows all data types available for mapping:

{
    "badges": [
        "Test Badge"
     ],
    "dates": {
        "Test Date [dat]": 1600128000000
    },
    "flags": { --booleans
        "Test Boolean [bln]": true
    },
    "metrics": { --numbers
        "Lifetime visit count": 12
    },
    "metric_sets": { --tallies
        "Test Tally [tly]": {
            "A": 1,
            "B": 2,
            "C": 3
        }
    },
    "properties": { --strings
        "Test String [str]": "Hello"
    },
    "property_sets": { --sets of strings
        "Test Set of Strings [ss]": [
            "A",
            "B",
            "C"
        ]
    },
    "property_lists": { --arrays of strings
        "Test Array Strings [arrs]": [
            "A",
            "A",
            "B"
        ]
    },
    "metric_lists": { --arrays of numbers
        "Test Array Numbers [arrn]": [
            1.0,
            1.0,
            2.0
        ]
    },
    "flag_lists": { --arrays of booleans
        "Test Array Booleans [arrb]": [
            true,
            true,
            false
        ]
    }
}

Map all attributes from the input visitor profile that you want to use in the Trimou template. The values of the mapped attributes become available to the Trimou rendering engine.

The following shows the data types available for mapping when setting up your template variables:

Syntax

The syntax examples in the sections below reference the visitor profile.

Variable Substitution

The name of a variable is a placeholder for its data value. Variable substitution references this value with double curly braces, such as {{var}} .

In the following example, the String variable {{str}} is substituted with it’s value Hello .

The following example gets the first value in the array of numbers {{arrn}}, referenced by specifying the index .

Sections

A section of content, surrounded by opening {{#var}} and closing {{/var}} tags, is rendered if there is an object found for the given key. This includes a Boolean of value true , a non-empty Iterable, and a non-empty array.

In the following example, since the Boolean variable bln is true, the content is rendered. The content does not render if the variable was false.

In the following example, since the array of Strings arrs is not empty, the content is rendered 3 times, once for each array element. The content does not render if the variable was false.

Inverted Sections

A section of content, surrounded by opening {{#var}} and closing {{/var}} tags, is rendered if there is no object found in the context. This includes a Boolean of value false, an Iterable with no elements, or an empty array.

In the following example, since bln is true , the content is not rendered. The content renders if the variable was false.

In the following example, since the variable missing is not defined in the visitor profile, the content is rendered.

Iteration

Trimou provides several helper functions to iterate an array. Nested attributes within an iteration are referenced by name. Trimou determines the context and parent (iteration element) they belong to.

In the above example, we mapped a Set of Strings to the variable “object.ss”, an Array of strings to the variable “object.arrs”, an Array of Numbers to the variable “object.arrn” and finally an Array of Booleans to the variable “object.arrb”. This means we can use Trimou to iterate over these attributes treating them as aligned arrays collectively, by iterating over the variable “object”. The example below shows this.

The following are the Trimou built-in iteration helpers:

• iter.index (the first element is at index 1)

• iter.isFirst

• iter.isLast

• iter.hasNext

• {{#object}} and{{/object}} mean that we are iterating over the 4 variables that we have prefixed “object.”

• {{iter.index}} is the current iteration index, starting at 1.

• {{#iter.isFirst}}"first":"true",{{/iter.isFirst}} renders the text inside if it is the first iteration

• {{#iter.isLast}}"last":"true",{{/iter.isLast}} renders the text inside if it is the last iteration

• {{ss}}inside the{{#object}} mean that we are referring to the item in the Set of Strings at this position, since we mapped the Set of Strings to “object.ss”.

• The same goes for {{arrs}},{{arrn}} and{{arrb}}respectively to refer to the Array of Strings, the Array of Numbers and the Array of Booleans

• {{#iter.hasNext}}, {{/iter.hasNext}} renders a comma if the iteration has more elements (iterHasNext is true )

Template

"MyData":[
{{#object}}
{
    "idx":{{iter.index}},
    {{#iter.isFirst}}"first":"true",{{/iter.isFirst}}
    {{#iter.isLast}}"last":"true",{{/iter.isLast}}
    "ss": "{{ss}}",
    "arrs": "{{arrs}}",
    "arrn": "{{arrn}}",
    "arrb": "{{arrb}}",
    }{{#iter.hasNext}}, {{/iter.hasNext}}
{{/object}}
]

Rendered Value

"MyData": [{
    "idx": 1,
    "first": "true",
    "ss": "A",
    "arrs": "A",
    "arrn": "1.0",
    "arrb": "true",
}, {
    "idx": 2,
    "ss": "B",
    "arrs": "A",
    "arrn": "1.0",
    "arrb": "true",
}, {
    "idx": 3,
    "last": "true",
    "ss": "C",
    "arrs": "B",
    "arrn": "2.0",
    "arrb": "false",
}]

For iterating over a tally (we mapped the tally to “tly” in the example above), you can use a special iterator, called the entrySet. Inside this, you can refer to the key and the value, as in the example below

Template

"MyTally":{
{{#each tly.entrySet}}
    "{{key}}": "{{value.toInteger}}"{{#iter.hasNext}},{{/iter.hasNext}}
{{/each}}
}

Rendered Value

"MyTally": {
    "A": "1",
    "B": "2",
    "C": "3"
}

Helper Functions

Templates provide additional and custom functionality through Tealium provided helper functions. They allow for transforming data and make it easier to generate the desired document format.

castIntegers

Customer Data Hub uses decimals to store various numbers. This helper forces the output in collections to be integer values. Can be used with toJson.

encodeBase64

Encode content in base64.

encodeUrl

URL-encode content.

escapeHtml

Escape values for use in HTML documents.

escapeJson

Escape values for use in JSON objects/arrays.

escapeXml

Escape values for use in XML documents.

formatDate

Formats date variable according to specified pattern. Pattern syntax corresponds to Java’s Simple Date formatting. For full table listing, see the Java Simple Date Format documentation.

hash

HMAC Generator, computes a Hash-based message authentication code (HMAC) using a secret key. A HMAC is a small set of data that helps authenticate the nature of message; it protects the integrity and the authenticity of the message.

The secret key is a unique piece of information that is used to compute the HMAC and is known both by the sender and the receiver of the message. This key will vary in length depending on the algorithm that you use.

The following example assumes that testKey , timestamp , ip and lang exist as valid input variables in the Trimou template.

if

Print the content if the variable exists and has content. The following example assumes that lang exist as valid input variables in the Trimou template.

isEq

Print the content if the values are equal.

isNotEq

Print the content if the values are equal.

join

Join will convert a list into a string with an optional joiner. Assuming empty_list is an empty list, no value is rendered.

jsonMinify

If provided content that contains valid JSON, minifies it (removes all whitespace). If the content is not valid JSON, the original value is shown with no changes.

md5

MD5 hash the content.

sha1

SHA1 hash the content.

sha256

SHA256 hash the content.

substring

Print the substring that begins at the specified start index and ends at the specified end index - 1.

substringAfter

Print the substring after the specified separator string.

substringAfterLast

Print the substring after the last occurrence of the specified separator string.

substringBefore

Print the substring before the specified separator string.

substringBeforeLast

Print the substring before the last occurrence of the specified separator string.

substringBetween

Print the substring between the specified open and close strings.

sum

Sum all of the values in a list or tally.

toInteger

Convert a variable’s value to an integer.

toJson

Print the variable in a JSON format.

toList

Convert a JSON-formatted-array string into an array for additional operations.

For arrn: ["1","2","2"]:

toTimestamp

Convert a date variable’s value to the Unix seconds timestamp format.

toTimestampMs

Convert a date variable’s value to the Unix milliseconds timestamp format.

unixTimestamp

Print the connector fire time in seconds since Unix epoch. This is useful for authorization headers. Optionally, format the date variable according to a specified pattern. Pattern syntax corresponds to Java’s Simple Date formatting. For full table listing, see the Java Simple Date Format documentation.

unixTimestampMs

Print the connector fire time in milliseconds since epoch. This is useful for authorization headers. Optionally, format the date variable according to a specified pattern. Pattern syntax corresponds to Java’s Simple Date formatting. For full table listing, see the Java Simple Date Format documentation.

unless

Print the content if the parameter does not exist or has no content.

uuid

Print a randomly generated UUID. Useful for creating nonces.