Templating system
Template model
Template::Core
Types
plain template
{
"type": "plain",
"content": {
"body": "Hei {{name}}"
}
}email template
email channel.{
"type": "email",
"content": {
"subject": "Welcome!",
"body": "<b>Hei {{name}}</b>",
"preheader": "We welcome you"
}
}bee_email template
email by containing JSON source which is used by JSON generated by Beefree to generate HTML body (readonly).push template
push channel.{
"type": "push",
"content": {
"subject": "Welcome",
"body": "Hi {{name}}!",
"url": "iml://app/cpn",
"data": { "something": "special" },
"android_payload": { "notification_count": 420 },
"ios_payload": { "badge": 33 }
}
}generic template
{
"type": "generic",
"content": {
"subject": "Welcome",
"body": "Hi {{name}}!",
"url": "iml://app/cpn"
}
}Liquid template language
Template content example
Having this as a body of SMS sent to MPC members:A following text will be received by member that has some points: A following text will be received by member that has no points:
{% if member_bonus_points %}
Your points balance is {{ member_bonus_points }}! :)
{% else %}
You have no points :(
{% endif %}Your points balance is 540 :)You have no points :(Merge properties
| merge-tag | Description |
|---|---|
member_id | |
member_secret_id | Special member's ID of used to authorize member in some MPC services |
member_msisdn | |
member_email | |
member_app_token | |
member_* | Member property (e.g. member_first_name) - the set depends on LC configuration |
dmp_* | DMP value for member (e.g. dmp_bonus_points) - available for audience members only, the set depends on LC configuration |
properties may be used .ExampleFor Sending with arbitrary recipients provided as following: The properties may be used like this:
[
{ "email": "piotr@example.com", "properties": { "first_name": "Piotr", "some_object": { "points": 15} } },
{ "email": "ola@example.com", "properties": { "first_name": "Ola", "some_object": { "points": 42 } } }
]Hello {{ first_name }}.
Your email is {{ email }}.
Your points balance is {{ some_object.points }}.Internationalized content
language property to the content payload to make it the default content version.Secondly, versions for another languages should be provided in the
translations property - it is an array of contents (having the same data format as regular one) in other languages.Example:
{
"template": {
"type": "plain",
"content": { "language": "en", "body": "Hi {{first_name}}. Sent at {{date}}" },
"translations": [
{ "language": "pl", "body": "Witaj {{first_name}}. Wysłano {{date}}" },
{ "language": "no", "body": "Hallo {{first_name}}. Postet {{date}}" }
]
}
}Template wrapping
A Template may be wrapped by another Template (Standalone) by providing On sending execution, if channel's template has a wrapper assigned, each content attribute (body, subject, etc) of the template will be injected into special When wrapper has no specific content attribute defined, it will be ignored. Wrapping is not recursive, so if template A has a template B as a wrapper and template B has a template C as a wrapper,
template A will be wrapped by Template B, but template B will not be wrapped by Template C. The type of wrapper that can be assigned to a template depends on given template type, as follows:
wrapper_id.{{ content }} merge-property of corresponding wrapper's attribute.template A will be wrapped by Template B, but template B will not be wrapped by Template C.
| Template type | Wrappable with |
|---|---|
plain | generic, email, bee_email, push, plain |
generic | generic, email, bee_email, push |
email | generic, email, bee_email |
push | generic, push |
bee_email | generic |
Sample wrapper definition:Consider this wrapper to be assigned to a template as following: Effectively, following content will be used during sending execution after wrapping and merging:
{
"id": 609193,
"wrapper_id": null,
"type": "generic",
"content": {
"subject": "Important message for {{member_first_name}}",
"body": "Hi {{member_last_name}}! {{content}}",
"url": null // Empty, so it won't be used on wrapping
}
}{
"id": 609194,
"wrapper_id": 609193,
"type": "push",
"content": {
"subject": "I will be replaced by wrapper",
"body": "Your last name is {{member_last_name}}!",
"url": "foo://bar"
}
}{
"subject": "Important message for Piotr",
"body": "Hi Piotr! Your last name is Åšwitlicki!",
"url": "foo://bar"
}