Tealium Learning Center

How to configure an advanced Webhook - Send Custom Request action using Template Variables for Keen.io API PRE-REQUISITES Introduction to Webhook - Send Custom Request Action Introduction to Webhook - Send Custom Request - Template Variables Guide Introduction to Webhook - Send Custom Request - Trimou Templating Engine Guide Overview Submit an http request to Keen.io to record multiple purchase events for a single transaction. Whole request body is a JSON message. Vendor Requirements Documentation: Keen IO Data Collection API   Request URL https://api.keen.io/API_VERSION/projects/PROJECT_ID/events API Request Body Example: {    "purchases": [        {            "item": "Golden gadget",            "price": 25.50,            "transaction_id": "f029342"        },        {            "item": "Different gadget",            "price": 17.75,            "transaction_id": "f029342"        }    ],    "transactions": [        {            "id": "f029342",            "items": 2,            "total": 43.25        }    ] }   Action Implementation Method Field Set to “POST”. URL Field Set to “{{url_template}}”.   URL can either be hard coded (with embedded api version and project ID) or template based. The latter approach is taken to allow greater flexibility with data layer attributes. See templates section below. Body Content Type Select option “application/json”. Body Data Select “Body” option and provide a template reference. Name Value Body {{json_template}} Template Variables Set name and value pairs to be referenced and replaced in templates. Variable values are custom values in this example, but can easily be provided as dynamic data layer attributes.   Name Value Note transactionId f029342   transactionItemCount 2   transactionTotalPrice 43.25   purchases.item Keen.io Purchase Items Set of Strings attribute purchases.price Keen.io Purchase Prices Set of Strings attribute apiVersion 3.0   projectId 98765   Variables are internally translated to JSON and made available to all templates. Resulting JSON structure: {  "purchases": [    {      "price": "17.75",      "item": "Different gadget"    },    {      "price": "25.50",      "item": "Golden gadget"    }  ],  "apiVersion": "3.0",  "transactionId": "f029342",  "transactionItemCount": "2",  "transactionTotalPrice": "43.25",  "projectId": "98765" }   Templates Name Value url_template https://api.keen.io/{{apiVersion}}/projects/{{projectId}}/events json_template {    "purchases": [        {{#purchases}}        {            "item": "{{item}}",            "price": {{price}},            "transaction_id": "{{transactionId}}"        }{{#iter.hasNext}}, {{/iter.hasNext}}        {{/purchases}}    ],    "transactions": [        {            "id": "{{transactionId}}",            "items": {{transactionItemCount}},            "total": {{transactionTotalPrice}}        }    ] } Templates Rendered Internally templates get rendered (see below) and their content injected where referenced (i.e.: URL field and Body).   Name Value url_template https://api.keen.io/3.0/projects/98765/events json_template {    "purchases": [        {            "item": "Different gadget",            "price": 17.75,            "transaction_id": "f029342"        },        {            "item": "Golden gadget",            "price": 25.50,            "transaction_id": "f029342"        }    ],    "transactions": [        {            "id": "f029342",            "items": 2,            "total": 43.25        }    ] } Action Configuration Screenshot   ... View more

How to configure an advanced Webhook - Send Custom Request action using Template Variables for Salesforce Predictive Intelligence API PRE-REQUISITES Introduction to Webhook - Send Custom Request Action Introduction to Webhook - Send Custom Request - Template Variables Guide Introduction to Webhook - Send Custom Request - Trimou Templating Engine Guide Overview Submit an http request to Salesforce Predictive Intelligence (formerly iGoDigital) to record a change to user’s shopping cart. Shopping cart is expressed as JSON URL parameter. Vendor Requirements API Request Example: https://nova.collect.igodigital.com/c2/6391707/track_conversion?payload={.......} URL parameter “payload” value is JSON: {    "cart": [        {            "item": "2890-17738",            "quantity": "1",            "price": "94.00",            "unique_id": "1233388"        },        {            "item": "2890-60773",            "quantity": "2",            "price": "133.00",            "unique_id": "7113048"        },        {            "item": "3414-301727",            "quantity": "3",            "price": "1.99",            "unique_id": "7107457"        }    ],    "order_number": "830100487001",    "discount": "89.99",    "shipping": "0.00",    "user_info": {        "email": "abc.xxx@tealium.com",        "details": {}    } } Action Implementation Method Field Set to “GET”. URL Field Set to “{{url_template}}”.   URL can either be hard coded (with embedded project ID) or template based. The latter approach is taken to allow greater flexibility with data layer attributes. See templates section below. URL Parameters Name Value payload {{json_template}} Template Variables Set name and value pairs to be referenced and replaced in templates. Variable values are custom values in this example, but can easily be provided as dynamic data layer attributes. Name Value Note projectId 6391707   cart.item PredictIntel Cart Items Set of Strings attribute cart.quantity PredictIntel Cart Quantities Set of Strings attribute cart.price PredictIntel Cart Prices Set of Strings attribute cart.id PredictIntel Cart IDs Set of Strings attribute orderNumber 830100487001   discount 89.99   shipping 0.00   userEmail abc.xxx@tealium.com   Variables are internally translated to JSON and made available to all templates. Resulting JSON structure: {  "shipping": "0.00",  "orderNumber": "830100487001",  "userEmail": "abc.xxx@tealium.com",  "cart": [    {      "id": "7113048",      "price": "1.99",      "item": "3414-301727",      "quantity": "3"    },    {      "id": "7107457",      "price": "133.00",      "item": "2890-60773",      "quantity": "2"    },    {      "id": "1233388",      "price": "94.00",      "item": "2890-17738",      "quantity": "1"    }  ],  "projectId": "6391707",  "discount": "89.99" } Templates Name Value url_template https://nova.collect.igodigital.com/c2/{{projectId}}/track_conversion json_template {{#jsonMinify}} {    "cart": [        {{#cart}}        {            "item": "{{item}}",            "quantity": "{{quantity}}",            "price": "{{price}}",            "unique_id": "{{id}}"        }{{#iter.hasNext}}, {{/iter.hasNext}}        {{/cart}}    ],    "order_number": "{{orderNumber}}",    "discount": "{{discount}}",    "shipping": "{{shipping}}",    "user_info": {        "email": "{{userEmail}}",        "details": {}    } } {{/jsonMinify}} Templates Rendered Internally templates get rendered (see below) and their content injected where referenced (i.e.: URL field and URL parameter). Name Value url_template https://nova.collect.igodigital.com/c2/6391707/track_conversion json_template {    "cart": [        {            "item": "3414-301727",            "quantity": "3",            "price": "1.99",            "unique_id": "7113048"        },        {            "item": "2890-60773",            "quantity": "2",            "price": "133.00",            "unique_id": "7107457"        },        {            "item": "2890-17738",            "quantity": "1",            "price": "94.00",            "unique_id": "1233388"        }    ],    "order_number": "830100487001",    "discount": "89.99",    "shipping": "0.00",    "user_info": {        "email": "abc.xxx@tealium.com",        "details": {}    } } Action Configuration Screenshot ... View more

How to configure the Facebook App Events API using the Webhook - Send Custom Request action with Templates and Template Variables. Prerequisites Introduction to Webhook - Send Custom Request Action Introduction to Webhook - Send Custom Request - Template Variables Guide Introduction to Webhook - Send Custom Request - Trimou Templating Engine Guide Overview Submit an HTTP request to Facebook to track one or more in-app conversions. Event data is expressed as a JSON encoded string. See the Facebook App Events API for more details.  API Call Example: curl \  -F "event=CUSTOM_APP_EVENTS" \  -F "advertiser_id=1111-1111-1111-1111" \  -F "advertiser_tracking_enabled=1" \  -F "application_tracking_enabled=1" \  -F "custom_events=[{\"_eventName\":\"fb_mobile_purchase\",                      \"_valueToSum\":55.22,                      \"_logTime\":1367017882,                      \"fb_currency\":\"GBP\",                                            }]" \  "https://graph.facebook.com/<API_VERSION>/<APP_ID>/activities"  The provided curl example (with the -F option) implies the request uses a POST method and its body is “multipart/form-data” content type. Let's break down the whole request into separate components that can be configured in the Webhook. 1. API Endpoint/URL https://graph.facebook.com/<API_VERSION>/<APP_ID>/activities In the example the URL has placeholder values for the API version and the APP_ID. These could probably be hard-coded into the URL, but for demonstration purposes we'll use a URL Template to create this component using dynamic values. 2. Simple Form Field Values  event = CUSTOM_APP_EVENTS  advertiser_id = 1111-1111-1111-1111  advertiser_tracking_enabled = 1  application_tracking_enabled = 1 These key/value pairs are simple form fields that can be mapped using Custom Values in the Body Data section. 3. JSON Value custom_events = [{ "_eventName" : "fb_mobile_purchase",                   "_valueToSum" : 55.22,                   "_logTime" : 1367017882,                   "fb_currency" : "GBP",                                        }] This particular field named "custom_events" has a more complicated value, a JSON string. To recreate this value in the Webhook we'll use Template Variables and a Template. Webhook Settings Method Field Set to “POST”. URL Field Set to “{{url_template}}”.  URL can either be hard coded (with embedded api version and app ID) or template based. The latter approach is taken to allow greater flexibility with data layer attributes. See templates section below. Body Content Type Select option “multipart/form-data”. Body Data Set name/value pairs for each field from the example request. Notice that the value for custom_events is the name of the Template we create, "events_template". Facebook Field Names Custom Value Comment event CUSTOM_APP_EVENTS   advertiser_id  1111-1111-1111-1111   advertiser_tracking_enabled  1   application_tracking_enabled  1   custom_events {{events_template}} References the template created below Parameter values are custom/static values in this example, but can easily be provided as dynamic Data Layer Attributes. Template Variables Set name/value pairs to be referenced and replaced in the Templates. Template Variable Name Type Value Note name Custom Value "fb_mobile_purchase"   currency Custom Value "USD"   logTime Data Attribute Current Time eg. 1468358987 eventSums.value Set of Strings Attribute FB Event Sums The dot-naming convention creates a matching section in the Template. Array value: [0.99, 4.99] apiVersion Custom Value "v2.6" For use in the URL Template appId Custom Value "123456" For use in the URL Template Templates You will create two templates, one for the URL and one for the JSON value to be assigned to the custom_events parameter. Notice that the Templates make use of the Template Variables using the curly brackets syntax. It's important to understand that this template is based on the "eventSums.value" variable which is populated by a Set of String Attribute. This is an array Attribute so the template will create a section for the prefix of the template variable name we used (in this case "eventSums"). Template Name Value url_template https://graph.facebook.com/{{apiVersion}}/{{appId}}/activities events_template [ {{#eventSums}} { "_eventName" : "{{name}}", "_valueToSum" : {{value}}, "_logTime" : {{logTime.toTimestamp}}, "fb_currency" : "{{currency}}" }{{#iter.hasNext}}, {{/iter.hasNext}} {{/eventSums}} ] Rendered Templates The Templates get rendered and their content used wherever they are referenced in the Webhook settings (in this example, the URL and the "custom_events" field in the Body Data). Notice that the "_valueToSum" parameter receives the values from the Set of Strings Attribute. Name Value url_template https://graph.facebook.com/v2.6/12345/activities events_template [    {        "_eventName" : "fb_mobile_purchase",        "_valueToSum" : 0.99,        "_logTime" : 1468358987,        "fb_currency" : "USD"    },    {        "_eventName" : "fb_mobile_purchase",        "_valueToSum" : 4.99,        "_logTime" : 1468358987,        "fb_currency" : "USD"    } ] Action Configuration Screenshot ... View more

This article describes how to design templates using the Trimou templating engine in Webhook, with the Send Custom Request action. Table of Contents Placeholder Prerequisites Introduction to Webhook - Send Custom Request Action Introduction to Webhook - Send Custom Request - 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 . Template Rendered Value {{str}}   Hello {{str}} world Hello world The following example gets the first value in the array of numbers  {{arrn}} , referenced by specifying the index 0 . Template Rendered Value The value is  {{arrn.0}} The value is 1.0 The value is  {{arrn.1}} The value is 1.0 The value is  {{arrn.2}} The value is 2.0 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 . Template Rendered Value {{#bln}} Section of content {{/bln}} Section of content 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 . Template Rendered Value {{#arrs}} Section of content  {{/arrs}} Section of content Section of content Section of content 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 . Template Rendered Value {{^bln}} Section of content {{/bln}}   In the following example, since the variable   missing  is not defined in the visitor profile, the content is rendered. Template Rendered Value {{^missing}} Section of content {{/missing}} Section of content 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 Rendered Value "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}} ] "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 Rendered Value "MyTally":{ {{#each tly.entrySet}} "{{key}}": "{{value.toInteger}}"{{#iter.hasNext}},{{/iter.hasNext}} {{/each}} } "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 . Template Rendered Value tally {A=1.0, B=2.0, C=3.0} tally.castIntegers {A=1, B=2, C=3} tally.castIntegers.toJson {"A":1,"B":2,"C":3} encodeBase64 Encode content in base64. Template Rendered Value {{#encodeBase64}}    {{str}} world {{/encodeBase64}} wqDCoEhlbGxvIHdvcmxkCg== encodeUrl URL-encode content. Template Rendered Value {{#encodeUrl}}https://www.google.com/search?q=tealium{{/encodeUrl}} https%3A%2F%2Fwww.google.com%2Fsearch%3Fq%3Dtealium escapeHtml Escape values for use in HTML documents. Template Rendered Value {{#escapeHtml}}<hello>&\"world{{/escapeHtml}} &lt;hello&gt;&amp;&quot;world escapeJson Escape values for use in JSON objects/arrays.  Template Rendered Value {{#escapeJson}}{"foo":"bar"}{{/escapeJson}} {\"foo\":\"bar\"} escapeXml Escape values for use in XML documents. Template Rendered Value {{#escapeXml}}<hello>&\"world{{/escapeXml}} &lt;hello&gt;&amp;&quot;world 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. Template Rendered Value {{dat}} 2020-09-15T00:00:00.000Z {{formatDate dat pattern="yyyy-MM-dd HH:mm a"}} 2020-09-15 00:00 AM 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. Template Explanation Rendered Value {{hash algorithm="HmacSHA256" encodingCharset="UTF-8" binaryEncoding="hex" joinOn="" useSecretKey="true" testKey timestamp ip lang}} Template Variables: testKey , timestamp , ip , timestamp and since useSecretKey="true" the first variable provided i.e. testKey will be used as the Secret Key for HMAC calculation For example, if the concatenation of the timestamp, ip and lang are: 2020-08-20T08:45:33.412127.0.0.1en-US and the testKey is w8sZzy8EaPaxFKfaoTqUi6 The result is: a0afb572e3fc174c2dea112e1a9922fb9903caa65e6aa9e50e47758b8a611542 Options Required Possible Values Description algorithm Yes example: HmacSHA256 available options are: - when secretKey="true" refer to Java Mac Algorithms - when secretKey="false" refer to Java MessageDigest Algorithms encodingCharset No UTF-8 (Default), US-ASCII   binaryEncoding No base64 (Default), hex   binaryEncodingOptions No lowercase (Default), uppercase only applies when binaryEncoding="hex" joinOn No   input concatenation separator; provide empty value "" if you need to concatenate on empty useSecretKey No false (Default), true   secretKey No     variables YES   Place all variables after the last option specified. For example: - if secretKey="true" , the first variable after all options are specified will be used as secretKey and all the others as the variables to be joined by joinOn option. - if secretKey="false" , they will all be used as variables to be joined by joinOn option. 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. Template Rendered Value {{#if str}} {{str}} world! {{/if}} Hello world! {{#if arrn}} {{arrn.toJson}} {{/if}} [1.0,1.0,2.0] {{#if ss}} {{ss.toJson}} {{/if}}  ["A","B","C"] isEq Print the content if the values are equal. Template Rendered Value {{#isEq bln true}}Boolean is true{{/isEq}} Boolean is true {{#isEq bln false}}Boolean is false{{/isEq}}   {{#isEq str "Hello"}}String is Hello{{/isEq}} String is Hello {{#isEq str "Test"}}String is Test{{/isEq}}   isNotEq Print the content if the values are equal. Template Rendered Value {{#isNotEq bln true}}Boolean is false{{/isNotEq}}   {{#isNotEq bln false}}Boolean is true{{/isNotEq}} Boolean is true {{#isNotEq str "Hello"}}Hello world!{{/isNotEq}}   {{#isNotEq str "Some string"}}Hello there!{{/isNotEq}} Hello there! join Join will convert a list into a string with an optional joiner. Assuming empty_list is an empty list, no value is rendered. Template Rendered Value {{join ss}} A,B,C {{join ss on=" and "}} A and B and C {{join ss on=""}} A B C {{join empty_list on=" and "}}   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. Template Rendered Value {{#jsonMinify}} { "name" : "Bob", "status" : "He is hungry!", } {{/jsonMinify}} {"name":"Bob","status":"He is hungry!"} md5 MD5 hash the content. Template Rendered Value {{#md5}}Hello World!{{/md5}} ed076287532e86365e841e92bfc50d8c sha1 SHA1 hash the content. Template Rendered Value {{#sha1}}Hello world!{{/sha1}} d3486ae9136e7856bc42212385ea797094475802 sha256 SHA256 hash the content. Template Rendered Value {#sha256}}Hello World!{{/sha256}} 7f83b1657ff1fc53b92dc18148a1d65dfc2d4b1fa3d677284addd200126d9069 substring Print the substring that begins at the specified start index and ends at the specified end index - 1. Template Rendered Value {{sequence}} "123456789" {{substring sequence start="0" end="5"}} "12345" substringAfter Print the substring after the specified separator string. Template Rendered Value {{screensize}} "340x480x640" {{substringAfter screenSize separator="x"}} "480x640" substringAfterLast Print the substring after the last occurrence of the specified separator string. Template Rendered Value {{screensize}} "340x480x640" {{substringAfterLast screenSize separator="x"}} "640" substringBefore Print the substring before the specified separator string. Template Rendered Value {{screensize}} "340x480x640" {{substringBefore screenSize separator="x"}} "340" substringBeforeLast Print the substring before the last occurrence of the specified separator string. Template Rendered Value {{screensize}} "340x480x640" {{substringBeforeLast screenSize separator="x"}} "340x480" substringBetween Print the substring between the specified open  and close strings. Template Rendered Value {{animals}} "cat dog tiger duck" {{substringBetween animals open="cat" close="duck"}} " dog tiger " sum Sum all of the values in a list or tally. Template Rendered Value {{tly.sum}} 6.0 {{arrn.sum}} 4.0 toInteger Convert a variable’s value to an integer. Template Rendered Value {{num}} 1.0 {{num.toInteger}} 1 toJson Print the variable in a JSON format. Template Rendered Value {{tly}} {A=1.0, B=2.0, C=3.0} {{tly.toJson}} {"A":1.0,"B":2.0,"C":3.0} toList Convert a JSON-formatted-array string into an array for additional operations. For arrn: ["1","2","2"] : Template Rendered Value {{arrn.toList.sum}} 4.0 toTimestamp Convert a date variable’s value to the Unix seconds timestamp format. Template Rendered Value {{dat}} 2020-09-15T00:00:00.000Z {{dat.toTimestamp}} 1600128000 toTimestampMs Convert a date variable's value to the Unix milliseconds timestamp format. Template Rendered Value {{dat}} 2020-09-15T00:00:00.000Z {{dat.toTimestampMs}} 1600128000000 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. Template Rendered Value {{unixTimestamp}} 1599859440 {{unixTimestamp format="yyyy-MM-dd HH:mm a"}} 2020-09-11 21:24 PM 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. Template Rendered Value {{unixTimestampMs}} 1599859605838 {{unixTimestampMs format="yyyy-MM-dd HH:mm a"}} 2020-09-11 21:26 PM unless Print the content if the parameter does not exist or has no content. Template Rendered Value {{#unless str}}str doesn't exist or no content{{/unless}}   {{#unless str2}}str2 doesn't exist or no content{{/unless}} str2 doesn't exist or no content uuid Print a randomly generated UUID. Useful for creating nonces. Template Rendered Value {{uuid}} 4d61f298-2a8d-461d-a3bf-b153892a7b49     ... View more

Prerequisites Introduction to Webhook - Send Custom Request Action Introduction to Webhook - Send Custom Request - Trimou Templating Engine Guide Overview If your custom request requires a complex payload, such as nested JSON or XML, you will use the Templates option to construct a payload in the format needed by the vendor's endpoint. Data layer attributes can be mapped to custom Template Variables, which in turn can be referenced within any template. This guide will show how to create Template Variables for both single key/value pairs and for array values. Single Value Variables The most common use for a Template Variable is to pass dynamic values from an Attribute into a placeholder within a Template. A Template Variable can be referenced in any Template by surrounding its name in double curly braces e.g. {{VARIABLE NAME}}. Here is an example payload required for tracking the status of a Shopping Cart: { "userEmail" : "bob@email.com", "total" : 9.99, "discount" : "10%", "date" : "2016-07-13T12:30:59.000Z" } You can see that each value will be dynamic and must be populated by a corresponding Attribute. The names for each value in this payload are the vendor's requirements for the format of the request. Template Variables are how you populate Attribute values into a request like this. The Template required to create this payload might look like this, where the values have been replaced by placeholders that reference the Template Variables we are going to use: { "userEmail" : "{{userEmail}}", "total" : {{itemTotal}}, "date" : "{{date}}", "discount" : "{{discount}}" }  Here is how you can accomplish this using Template Variables: 1. Start by identifying the Attributes you wish to include in the Body Data. For this example, you will use the following Cart details: Data Layer Attribute Type Template Variable Value Cart User Email String userEmail bob@email.com Cart Total Number itemTotal 9.99 Cart Date Date date 2016-07-13T12:30:59.000Z Cart Discount String discount 10% 2. In the Template Variables section, map each Attribute to a corresponding Template Variable name of your choosing.  3. In the Templates section, construct the appropriate template according to the vendor's specifications. Be sure to give it a useful name since this will also be referenced with double curly braces later on. We called this template "cartdetails". 4. In the Body Data section, map the Custom Value of "{{cartdetails}}" to the Body. Nested Map: One Level Array of Objects To construct a JSON array of objects, you must use an Array Attribute and the special “dotted names” convention in the naming of your Template Variables. When using this notation, the part of the name coming before the "." will automatically enable the use of a section within the Template referred to by that name. Let's look at an example to see how this works. Here is an example payload required for tracking Shopping Cart content: { "cart": [{ "item" : "Plate", "quantity": "1", "price" : "5.00", "id" : "001" }, { "item" : "Fork", "quantity": "2", "price" : "0.99", "id" : "002" }, { "item" : "Mug", "quantity": "1", "price" : "6.99", "id" : "003" }] } In order to construct a payload like that we would need a Template like this: { "cart": [ {{#cart}} { "item" : "{{item}}", "quantity" : "{{quantity}}", "price" : "{{price}}", "id" : "{{id}}" }{{#iter.hasNext}}, {{/iter.hasNext}} {{/cart}} ] } Using this example, you would use cart as the prefix in your Template Variables using dotted names e.g. cart.item Here we can see how the necessary Template Variables would be defined: Data Layer Attribute Type Template Variable Value Cart Items Array of Strings cart.item [ “Plate”, “Fork”, “Mug” ] Cart Quantities Array of Numbers cart.quantity [ “1”, “2”, “1” ] Cart Prices Array of Numbers cart.price [ “5.00”, “0.99”, “6.99” ] Cart Item IDs Array of Strings cart.id [ “001”, “002”, “003” ] Limitations for array of objects Only one level nested elements are supported. Deeper JSON structures are not possible. Data Layer Attributes must all be arrays of identical length. Cascade Map: Set Value Across Objects It is possible to cascade a single data attribute across every array object. All non-set-of-string attributes are cascaded as long as the variable name follows the special “period” character notation.   Example: Data Layer Attribute Attribute Type Variable Notes Cart Items Set of Strings cart.item Value = [ “Plate”, “Fork”, “Mug” ] Transaction ID String cart.transactionId Value = “T1284”   Resulting JSON: { "cart": [ { "item": "Plate", "transactionId": "T1284" }, { "item": "Fork", "transactionId": "T1284" }, { "item": "Mug", "transactionId": "T1284" } ] }   ... View more

This article describes how to create and configure custom API requests using Webhook. In this article: Table of Contents Placeholder The Webhook connector offers powerful actions that allow you to configure highly-customized HTTP requests. The connector actions described in this article allow you to control all aspects of an HTTP request and offer powerful templating features designed to handle complex and dynamic data formats. Prerequisites Introduction to the Webhook Connector A guide from your vendor specifying an HTTP request Connector Actions Action Name AudienceStream EventStream Send Customized Data via HTTP Request (Advanced) ✓ ✓ Send Batched Customized Data via HTTP Request (Advanced) ✓ ✓ Configure Settings If you have not done so already, go to the Connector Marketplace and add the Webhook connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Basic Authentication Optional. Username. Enter username if API endpoint requires basic authentication. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for the Customized Data and Batch Customized Data options. Action - Send Customized Data via HTTP Request (Advanced) Parameters PARAMETER DESCRIPTION Method Required. Select the request method. URL Required. Provide the URL to submit the request to. For template support, reference the template name to generate a URL from the template. URL Parameters Optional. Provide parameters to append to the URL. For template support, reference the template name to generate the parameter value from the template. Headers Optional. Map HTTP header values to header names. For template support, reference the template name to generate the header value from the template. Cookies Optional. Map cookie values to cookie names. Cookies are added as a single HTTP header value. Example: Cookie: name1=value1; name2=value2 For template support, reference the template name to generate the cookie value from the template. Body Content Type Optional. Select available type or provide a custom value. All types are UTF-8 encoded and are added as a header. Example: Content-Type: text/plain; charset=UTF-8 Content type is required if body data is provided Body Optional. Provide data to construct message body. Map values to names if body content type is "multipart/form-data" or "application/x-www-form-urlencoded", otherwise reference the template name and only select the Body option. For template support, reference the template name to generate body data from the template. Template Variables Optional. Provide template variables as data input for templates. Name nested template variables with the dot notation. Example: items.name Nested template variables are typically built from data layer list attributes. For additional information, see the Template Variables Guide. Templates Optional. Provide templates to be referenced in either URL, URL Parameter, Header or Body Data. Templates are injected by name with double curly braces into the supported fields. Example: {{SomeTemplateName}} When using OAuth, the template variable refers to the token returned by the auth request. For additional information, see the Templates Guide. Sending Access Tokens for Webhook OAuth2 Requests using Webhook OAuth2 must supply the access token in the request. The token generated by your OAuth2 connection is provided by the connector in a template variable named {{webhook_access_token}}, which is passed differently between each API. In the following example, it is expected in the Authorization: Bearer TOKEN_HERE "Authorization" header. Use the following steps generate and map this header: Create a template named auth_template using the following example: Bearer {{webhook_access_token}} In the Headers section, map this template to Authorization. Click Save. Save and Publish your changes. Action - Send Batched Customized Data via HTTP Request (Advanced) When sending batched data, individual items are combined in a batch and set after one of the following (default) limits are reached: Maximum batch size: 16 MB Maximum lifespan: 1 Hour Maximum record count: 100 items The values for maximum lifespan and maximum record count may be overridden, but maximum batch size cannot. Parameters Parameter Description Method Required. Select request method. URL Required. Provide URL to submit request to. For template support, reference the template name to generate a URL from the template. Body Content Type Optional. Select an available type or provide a custom value. All types are UTF-8 encoded and are added as a header. Example: Content-Type: text/plain; charset=UTF-8 Content type is required if body data is provided. Body Data Optional. Provide data to construct the message body. Map values to names if body content type is "multipart/form-data" or "application/x-www-form-urlencoded", otherwise reference the template name and only select the Body option. For template support, reference the template name to generate body data from the template. Prefix A non-repeating portion of the request that precedes Body Data. The JSON array prefix is the opening bracket character ([). Map Custom [ to Prefix. Example: [   {     "editable_in_signup": false,     "displayed_for_customers": true    },   {     "editable_in_signup": true,     "displayed_for_customers": true   } ] Joiner A character or string that separates individual data items in Body Data. The JSON objects joiner is the comma (,). Map Custom , to Joiner. Example: [   {     "editable_in_signup": false,     "displayed_for_customers": true    },   {     "editable_in_signup": true,     "displayed_for_customers": true   } ] Suffix A non-repeating portion of the request that follows Body Data. The JSON array prefix is the closing bracket character (]). Map Custom ] to Suffix. Example: [   {     "editable_in_signup": false,     "displayed_for_customers": true    },   {     "editable_in_signup": true,     "displayed_for_customers": true   } ] Record Count Maximum Record count maximum (default: 100) Valid range: 10 - 10,000 records Time To Live (minutes) Time to go live, in minutes (default: 60) Valid range: 5 - 60 minutes URL Parameters Optional. Provide parameters to append to the URL. For template support, reference the template name to generate a parameter value from the template. Headers Optional. Map HTTP header values to header names. For template support, reference the template name to generate the header value from the template. Cookies Optional. Map cookie values to cookie names. Cookies are added as a single HTTP header value. Example: Cookie: name1=value1; name2=value2 For template support, reference the template name to generate the cookie value from the template. Template Variables Optional. Provide template variables as data input for templates. For additional information, see the Template Variables Guide. Name nested template variables with the dot notation, for example: items.name . Nested template variables are typically built from data layer list attributes Templates Optional:. Provide templates to be referenced in either the URL, URL Parameter, Header or Body Data. For additional information, see the Templates Guide. Templates are injected by name with double curly braces into supported fields. Example: {{SomeTemplateName}} When using OAuth, the template variable refers to the token returned by the auth request. Validate the Action Use one of the following methods to verify and troubleshoot the new actions: Vendor User Interface If the vendor provides a web user interface that allows you to monitor changes, submit an action to the target vendor endpoint and verify it on the target endpoint. PutsReq Bucket Send a test request to a sample PutsReq bucket URL. After configuring the Action fields, go to the following URL to examine the request received using the PutsReq user interface. https://putsreq.com/YOURBUCKETNAME/inspect Trace Run the Trace tool and examine the action data. If you are using the template feature of this action, check the Template Variables JSON and Rendered Template: <template name>. When individual data items are added to a batch, trace displays batched actions first and then again after the batch is sent to the third party. Individual data items added to a batch are not batched in Trace. Multiple batching actions often correspond to a singe send-off action. There may be a considerable delay between the two Sample Action Configuration Go to https://putsreq.com/ and click Create a PutsReq to create an endpoint for testing. Copy the PutsReq URL. Go to the Actions settings for your Webhook connector. Scroll down to Method and click to expand. Select POST from the drop-down list. Scroll down to URL, click to expand, and paste the PutsReq URL into the URL parameter field. Click Save. Save and Publish your changes. Run a Trace to verify that the action triggered as expected. Vendor Use Cases The following list provides examples of advanced configurations via Webhook that offer a foundation and overview of the possibilities when using custom requests. Kony API Keen.io API Salesforce Predictive Intelligence (formerly iGoDigital) API Facebook App Events API ... View more

How to configure an advanced Webhook - Send Custom Request action using Template Variables for Kony API PRE-REQUISITES Introduction to Webhook - Send Custom Request Action Introduction to Webhook - Send Custom Request - Template Variables Guide Introduction to Webhook - Send Custom Request - Trimou Templating Engine Guide Overview Submit an http request to Kony with a list of subscriber IDs and name & value pairs. Whole request body is a JSON message. Vendor Requirements Sample JSON Message: {    "messageRequest": {        "appId": "IceMobile",        "global": {},        "messages": {            "message": {                "content": {                    "priorityService": "false",                    "data": "Message Body",                    "mimeType": "text/plain"                },                "overrideMessageId": 0,                "startTimestamp": 0,                "expiryTimestamp": 0,                "subscribers": {                    "subscriber": [                        {                            "ksid": "95784"                        },                        {                            "ksid": "97899"                        }                    ]                },                "platformSpecificProps": {                    "iphone": {                        "badge": 0,                        "customData": {                            "key": [                                {                                    "name": "trip_type",                                    "content": "o"                                },                                {                                    "name": "o",                                    "content": "LAX"                                },                                {                                    "name": "d",                                    "content": "NRT"                                },                                {                                    "name": "dd",                                    "content": "2016-01-09"                                },                                {                                    "name": "rd",                                    "content": "2016-01-20"                                }                            ]                        }                    }                },                "type": "PUSH"            }        }    } }   Notes Subscribers array is dynamic and can contain one or more subscriber IDs. "customData" key array is dynamic and can contain one or more name and content objects. Action Implementation Method Field Set to “POST”. URL Field Set to PutsReq bucket URL. Consult Kony API documentation for a URL. A PutsReq URL is adequate to demonstrate a general implementation here. Body Content Type Select option “application/json”. Body Data Select “Body” option and provide a template reference.   Name Value Body {{json_template}} Template Variables Set name and value pairs to be referenced and replaced in templates. Name Value Note subscribers.ksid Kony Sub IDs Set of Strings attribute customData.name Kony Data Names Set of Strings attribute customData.content Kony Data Contents Set of Strings attribute Variables are internally translated to JSON and made available to all templates. Resulting JSON structure: {    "subscribers": [        {            "ksid": "sub-id-1"        },        {            "ksid": "sub-id-2"        }    ]    "customData": [        {            "name": "name-1",            "content": "Content A"        },        {            "name": "name-2",            "content": "Content B"        },        {            "name": "name-3",            "content": "Content C"        }    ] } Templates Name Value json_template {    "messageRequest": {        "appId": "IceMobile",        "global": {},        "messages": {            "message": {                "content": {                    "priorityService": "false",                    "data": "Message Body",                    "mimeType": "text/plain"                },                "overrideMessageId": 0,                "startTimestamp": 0,                "expiryTimestamp": 0,                "subscribers": {                    "subscriber": [                        {{#subscribers}}                        {                            "ksid": "{{ksid}}"                        }{{#iter.hasNext}}, {{/iter.hasNext}}                        {{/subscribers}}                    ]                },                "platformSpecificProps": {                    "iphone": {                        "badge": 0,                        "customData": {                            "key": [                                {{#customData}}                                {                                    "name": "{{name}}",                                    "content": "{{content}}"                                }{{#iter.hasNext}}, {{/iter.hasNext}}                                {{/customData}}                            ]                        }                    }                },                "type": "PUSH"            }        }    } } Templates Rendered Internally template get rendered (see below) and its content injected where referenced (i.e.: Body). Name Value json_template {    "messageRequest": {        "appId": "IceMobile",        "global": {},        "messages": {            "message": {                "content": {                    "priorityService": "false",                    "data": "Message Body",                    "mimeType": "text/plain"                },                "overrideMessageId": 0,                "startTimestamp": 0,                "expiryTimestamp": 0,                "subscribers": {                    "subscriber": [                        {                            "ksid": "sub-id-1"                        },                        {                            "ksid": "sub-id-2"                        }                    ]                },                "platformSpecificProps": {                    "iphone": {                        "badge": 0,                        "customData": {                            "key": [                                {                                    "name": "name-1",                                    "content": "Content A"                                },                                {                                    "name": "name-2",                                    "content": "Content B"                                },                                {                                    "name": "name-3",                                    "content": "Content C"                                }                            ]                        }                    }                },                "type": "PUSH"            }        }    } } Action Configuration Screenshot   ... View more