First steps
User Data
- Responsive Email Editor Review
- Designing your email
- Creating Synchronized Modules
- Setting Up Responsive Email Design
- Setting Up Smart Containers
- Creating a Gmail Promotions Annotation
- Adding The Rollover Effect
- Adding Anchor Links
- Module Library
- Adding a Table to an Email
- Adding Custom Fonts
- Creating CTA Button
- Working with Images
- Creating Timer
- Using AI in the Email Editor
Omnichannel
- Setting Up Widgets for Your Site
- Widget Calling
- Setting Up Locations for the Widget Calling Rules
- Storing data from widgets to contact fields
- Using Annoyance Safeguard
- Actions After Form Submission
- Replacing Double Opt-In System Workflow
- Creating Pop-ups via Google Tag Manager or WordPress
- Sending Yespo Widget Events to Google Analytics
- Using A/B Tests for Widgets
- Collecting Contact Information Using Request Forms
Automation
- Building and Editing Workflows
- Configuring Workflow Start/Stop Conditions
- Start Block
- Popular Blocks
- Message Blocks
- Using One from Many Message Block
- Contact Blocks
- Conditions Blocks
- Other Blocks
- Message to Segment Blocks
- Time Blocks
- Advanced Workflow Block Parameters
- Setting Up Allowed Send Time
- Using Workflow Launch History
- Webhook Workflows
- Workflow Troubleshooting
- Double Opt-In
- Welcome Сampaign
- Welcome Series Segmented by Category
- Launching a Workflow After a Contact Import
- Regular Workflow for a Segment
- Birthday Campaign
- Linking Workflow to the Button
- Using Variables from Order in Workflow
- Collecting Order Feedback
- Customer Reactivation
- Sending Extra Campaigns
- Sending Reminders at the Time Specified by the User
- Sending Campaign to Those Who Did Not Open the Previous One
- Using A/B Tests In Workflows
Personalization
Analytics
- Email Campaign Report
- Web Push Campaign Report
- Viber Campaign Report
- Mobile Push Campaign Report
- App Inbox Campaign Report
- Telegram Campaign Report
- In-App Report
- Widget Report
- Triggered Campaign Report
- AMP Campaign Report
- SMS Campaign Report
- Multilingual Campaign Report
- Setting up UTM Tags
- Revenue from Campaigns
- Tracking Campaign Performance in Google Analytics 4
- Message Analytics
Multilanguage Campaigns
Events and Behaviour Tracking
Recommendations
API
Security and Compliance
Using Velocity Features in Yespo
Our system features the dynamic content option using the Apache Velocity library. Let’s review the most common Velocity features to use in Yespo.
Getting the single parameter
All external data is contained in the data object. To extract it to the message, use command $!data.get and specify the parameter name you want to extract:
$!data.get('parameter name')
Getting array elements by index
To get the array element by its index, specify the name of the array and the element’s index:
$!data.get('array name').get(0)
— if array contains only values, where 0 is the element's index (array indexes in JSON are 0-based).
$!data.get('array name').get(0).get('parameter name')
— if array contains objects with parameters.
This method is suitable when you know the array’s size in advance. If you specify the element's index that does not exist in the array, an error will occur when sending a message.
Get the array size
Syntax:
$!data.get('array name').size()
Loop to get all the array elements
Use the #foreach loop.
Syntax:
#foreach($item in $data.get('array name'))
$velocityCount: $item.get('name') ...
#end
$item is a variable assigned to the current array element and can be accessed inside the loop. In this case, the entire list of elements in the array will be displayed one by one; $velocityCount — the default name of the loop counter, its initial value starts from 1.
If you want to stop the #foreach loop, use the #break directive to stop the loop on the condition you want:
#foreach($item in $data.get('array name'))
$velocityCount: $item.get('name') ...
#if( $velocityCount > 5 ) #break #end
#end
Assignment
The 'value' variable can refer to specific values, other variables, or expressions.
Syntax:
#set($var='value')
Comparison
Comparison and logical operators:
Velocity comparison operators | Corresponding comparison operations |
gt | > (more) |
lt | < (less) |
ge | ≥ (more or equal) |
le | ≤ (less or equal) |
== | = (equal) |
!= | ≠ (not equal) |
and | && (logical AND) |
or | || (logical OR) |
not | ! (logical NOT) |
Syntax:
$!param1 gt $!param2
Also, you can use operators to compare strings with and without case sensitivity.
Syntax:
$!firstString.equals($!secondString)
$!firstString.equalsIgnoreCase($!secondString)
Condition
Use conditions in such cases:
- if you need to get only some specific data (for example, only one product category);
- if you need to display a certain amount of products in one block so as not to break the message layout.
Syntax:
#if ($data.get('params')=='value')
(content)
#end
If the condition is not met, you can display an alternative:
#if($data.get('param')=='value')
(content)
#else
(alternate content)
#end
You can also check several conditions:
#if($data.get('param')=='value1')
(content 1)
#elseif($data.get('param')=='value2')
(content 2)
#else
(alternate content)
#end
You can combine several conditions using the logical operators and / or:
#if ($data.get('param1')=='value1' and $data.get('param2')=='value2')
(content)
#end
To invert the condition use syntax:
#if (!($data.get('param')=='value'))
(content)
#end
Arithmetic operations
Addition:
$mathTool.add($v1, $v2)
Subtraction:
$mathTool.sub($v1, $v2)
Multiplication:
$mathTool.mul($v1, $v2)
Division:
$mathTool.div($v1, $v2)
Number formatting
Output of an integer without rounding:
$numberTool.integer($v1)
Output of money amounts with two decimal places:
$!numberTool.format('#.00',$v1)
Date displaying in message
Output of the current date:
$!dateTool.currentDate()
Output of the Unix TimeStamp (current date in milliseconds):
$!dateTool.currentTimeStamp()
Output of the date and/or time, the second argument can be set to Greenwich Mean Time (GMT):
$!dateTool.currentDate('dd.MM.yyyy HH:mm:ss', 'GMT+3')
If the date is passed in the Unix TimeStamp format (for example, 1495479520000), convert it to a readable format using the function:
$!dateTool.formatDate('dd.MM.yyyy',$!data.get('date'))
or specifying the format:
$!dateTool.formatDate('yyyy-MM-dd HH:mm:ss',$!data.get('date'))
Operations with dates
Add to the date the required number of units (year, month, day, hour, minutes). If you get a date like this from an event or an additional field: "date":"01/01/2020 12:00", the result of the operation will be as follows:
$!dateTool.addYears($!data.get('date'),2) -> 01/01/2022 12:00
$!dateTool.addMonths($!data.get('date'),5) -> 01/06/2020 12:00
$!dateTool.addDays($!data.get('date'),15) -> 16/01/2020 12:00
$!dateTool.addHours($!data.get('date'),7) -> 01/01/2020 19:00
$!dateTool.addMinutes($!data.get('date'),15) -> 01/01/2020 12:15
f the second argument is negative, the subtraction result will be returned.
By default, a date is expected in one of the listed formats.
- dd/MM/yyyy HH:mm
- dd/MM/yyyy
- yyyy-MM-dd'T'HH:mm
- yyyy-MM-dd
If the format is different, set your own format as the third argument. For example, if the date you pass in the format "customDate": "12:00 2020-30-04", the expression will take the form:
$!dateTool.addYears($!data.get('customDate'),2,'HH:mm yyyy-dd-MM') -> 12:00 2022-30-04
Similarly, by specifying the fourth argument, you can format the date, for example, if the date is in the format: "dateTime":"2020-05-01T00:00":
$!dateTool.addDays($!data.get('dateTime'), 2, "yyyy-MM-dd'T'HH:mm",'dd-MM-yyyy') -> 03-05-2020
$!dateTool.addHours($!data.get('dateTime'), 7, "yyyy-MM-dd'T'HH:mm",'dd/MM HH:mm') -> 01/05 07:00
$!dateTool.addMinutes($!data.get('dateTime'), 2, "yyyy-MM-dd'T'HH:mm",'HH:mm') -> 00:02
Calculating the difference of two dates in (minutes, days, months and years) "firstDate":"01/01/2019", "secondDate":"05/05/2020":
$!dateTool.diff($!firstDate,$!secondDate,'YEARS') -> 1
$!dateTool.diff($!firstDate,$!secondDate,'MONTHS') -> 16
$!dateTool.diff($!firstDate,$!secondDate,'DAYS') -> 490
$!dateTool.diff($!firstDate,$!secondDate,'HOURS') -> 11760
$!dateTool.diff($!firstDate,$!secondDate,'MINUTES') -> 705600
To calculate the difference, both dates must be in the same format, if your format differs from the default expected, the fourth argument can be a custom format, for example, for two dates: "customDate1":"17:15 05/05/2020", "customDate2 ":"10:05 01/01/2019":
$!dateTool.diff($!customDate1,$!customDate2,'HH:mm dd/MM/yyyy','MINUTES') -> 706030
Checking for a non-empty value
If you need to check whether a parameter was passed and whether it was empty, use the following code:
#if($data.get('param') and $data.get('param')!=’’)
(content)
#end
Usage: if the message contains an appeal to the user by name, but not all users have name parameters in the code.
Working with strings
Get the string length:
$!var.length()
Get the string part:
$!var.substring(start index, end index)
Replace the part of the string with a different value:
$!var.replace('what needs to be changed','value to set instead')
Change the case of a string:
#set ($example = "UkRaInE")
$example.toUpperCase() // UKRAINE
$example.toLowerCase() // ukraine