Message Blocks

Suggest Edits

Blocks send one message to one contact.

Contains six block types:

  • Email
  • SMS
  • Viber
  • Web Push
  • Mobile Push
  • App Inbox
Message Blocks

Common Block Parameters

Each action message contains several parameters:

  • Message: required parameter. You can select a message from the drop-down list or use dynamic variable.
Message

To copy a Message ID, click on the copy icon next to it.

Message ID
  • Phone (for SMS, Viber and Web Push blocks): required parameter, a phone number of the contact or event parameter containing it. The variable ${phoneNumber} is specified by default. In your event, the variable may be called ${SMS}, ${Phone}.
Phone

To check the exact title, go to Automation → Event history, and click the event that triggers the workflow.

Event parameters

A phone number is specified in digits, for example,12018627991, only for testing.

  • Contact ID. You can specify system contact ID other than an email address. Enter in field the name of the parameter containing the contact ID. For many system events, this parameter is called ContactId.
Contact ID
  • JSON: you can enter data in the JSON format or specify the event parameter that contains such data. Don't fill this field if you don’t pass in the event the parameter with the JSON line.
JSON

JSON example:

{

"name": "items",

"value": "{\"array\":[{\"name\":\"Brenda Flatform Sport Sandals\",\"price\":\"100.00\",\"url\":\"https://site.com/catalog/steve-madden-brenda-flatform-sport-sandals?ID=8472233&CategoryID=56233&swatchColor=Natural\",\"imageUrl\":\"https://site.com/uploads/product/big/20161122/20161122_7zvb.jpg\"},{\"name\":\"Cloudsteppers Women's Brio Sol Flip-Flop Sandals\",\"price\":\"78.00\",\"url\":\"https://site.com/catalog/clarks-cloudsteppers-womens-brio-sol-flip-flop-sandals?ID=10566812&CategoryID=56233&swatchColor=Red%20Synthetic\",\"imageUrl\":\"https://site.com/uploads/product/big/23112013/2125.jpg\"}]}"

}

Sharing the JSON field with the Get contact block requires access to data from this field through the intermediate jsonParam object, using the example of the array items, the field name of the first element will be available using this construction:

$!data.get('jsonParam').get('array').get(0).get('name')

If the Get contact block isn’t used, the construction will be:

$!data.get ('array')
  • Send only in specified hours: You can enable this parameter to send messages only within a specified time gap.
Send only in specified hours

By default, day hours from 08:00 to 20:00 are set as send hours. Such setting allows not to annoy recipients at an inappropriate time and schedule send at permitted hours. To change specified hours or change allowed hours for each day, go to your profile → Settings → Workflows.

Account settings

See more detailed information >

The corresponding marks on the block show whether this parameter is enabled for a particular message:

  1. Regular icon means the message can be sent at any time.
  2. Clock mark icon means the message can be sent only at specified hours.
Specified hours message icon

Email

The block sends one email to one contact.

Email

In addition to the common block parameters, the block has such parameters:

  • Email: email address of the contact or the event parameter that contains an email address. The variable ${emailAddress} is specified by default. If in your event this parameter has a different title, enter it.
  • Language: language ID or the event parameter containing it. It is needed to create multilingual messages. Leave the field blank if you don't use Multilanguage, or the language of the contacts is specified in their carts.
    Language parameter example:
Language

Language parameter can be entered in the following formats:

  • en, es, fr;
  • EN, ES, FR;
  • en-US, fr-CA, en-AR.
Language format

SMS

The block sends one SMS to one contact.

SMS

A phone number is specified in digits, for example,12018627991, only for testing.

Viber

The block sends one Viber message to one contact.

Viber

In addition to the common block parameters, the block has Message activity time (TTL) parameter. TTL it's a period after which the message will not be displayed if it has not been delivered by this time.

Viber messages are sent only to contacts with a phone number specified in the contact card. If the contact doesn’t have a phone number, the workflow will ignore the Viber block, and the Viber message won’t be sent to this contact.

Phone number

📘

Important

The block Viber will be ignored for contacts without a phone number if it’s included in a workflow with multiple blocks.

Web Push

The block sends one Web Push to one contact. After subscribing, the system will search for the contact among existing ones. If it manages to identify the contact, a push token will be added to that contact's card. If not, a new contact will be automatically created with the token only.

Web Push

In addition to the common block parameters, the block has such parameters:

  • Token. The variable ${pushToken} is specified by default.
  • Email. Email address of the contact or the event parameter that contains an email address. The variable ${emailAddress} is specified by default. If in your event this parameter has a different title, enter it.

📘

Important

To send Web Push, the system needs a token of the contact. If the data in the contact card is combined (email address+phone number+ID+token), the token can be found by other parameters, not necessarily ${pushToken}. The system will search in turn if the contact with a specified email, phone number or ID has a token.

Mobile Push

The block sends one mobile push notification to one contact.

📘

To send mobile pushes, you need to have an app which you need to connect to our platform. The block sends push notifications to the contact's mobile device if they have previously agreed (subscribed) to receive them.

Mob Push

In addition to the common block parameters, the block has such parameters:

  • Token: mobile token of the contact. The variable ${mobPushToken} is specified by default.

📘

Note

To send mobile pushes, the system needs a token of the contact. If the data in the contact card is combined (email address+phone number+ID+token), the token can be found by other parameters, not necessarily ${mobPushToken}. The system will search in turn if the contact with a specified email, phone number, or ID has a token.

  • Application: an app identifier for accounts with more than one app. You can select the app to send notifications from the dropdown list or specify dynamic parameter ${appId}. The system extracts the app ID from the event that has triggered the workflow. When sending events through the SDK, this parameter is passed automatically.

📘

Important

When searching contacts for Email, SMS, Viber, Mob Push and Web Push blocks, the following rules apply:

  • Contact ID has the highest priority among all parameters.
    Entered contact email, phone number, or token are used for sending.
  • If exteralCustomerId is specified, the sending is made to the contact it belongs to; among those contacts that were found by email address, phone number or token.
  • If exteralCustomerId is not specified, the sending is made to the contact found by email address, phone number or token.
  • If contact is not found, new contact will be created for sending.

App Inbox

The block sends one app inbox notification to one contact.

📘

Note

To send App Inbox messages to your customers, you first need to get an authentication token and configuring App Inbox for websites and mobile apps.

App Inbox

Updated 4 months ago