“Message” Object

Welcome to our newly overhauled Zephyr pages! See our new Overview, Examples, and Index.
Feedback is welcome at bottom of each page.

Within any Zephyr context, the messageobject contains a number of useful pieces of data about the current transactional email message. This object is intended for use with Triggers that require a custom Zephyr script. Note that the message object applies only to a sent email, so it would refer to the first transactional email that hosts the trigger. (Note that a trigger is second transactional that exists on the template of the first transactional.)

Triggers are also available through our API. See the trigger call.

Here is a sample message object:

{         
   "template" : "DC-template" ,         
   "sample" : "A",
   "revision_id" : 131152 ,         
   "send_time" : 1311284816 ,         
   "click_time" : 1301384816 ,         
   "open_time" : 1301394816 ,         
   "purchase_time" : 1309366347,         
   "clicks": [                 
           {                         
                "ts": 1309366347,                         
                "ip": "75.214.213.71"                   
            },                 
            {                         
                 "ts": 1309366357,                         
                 "ip": "75.214.213.71"                 
            }         
   ],         
   "opens": [                 
            {                         
                 "ts": 1309366347,                         
                 "ip": "75.214.213.71"                 
            },                 {                         
                 "ts": 1309366357,                         
                 "ip": "75.214.213.71"                 
            }         
    ],         
} 
Field Type Description
template string template name
revision_id integer Revision ID of the template
send_time integer UNIX timestamp of the earliest list signup time of this user
open_time integer UNIX timestamp of the most recent time the user last opened a message
click_time integer UNIX timestamp of the most recent time the user clicked a message
purchase_time integer UNIX timestamp of the most recent purchase by the user
clicks array List of click data containing IP and click time
opens array List of open data containing IP and click time
sample String A/B test sample string if set

 


Top