Event Data Field Definitions

Event data field definitions

The following table describes each value that can appear for a given event type.

Join_source

ValueDefinition
CODEIndicates that a user subscribed to SMS through a Text-to-Join keyword.
CHECKOUTIndicates that a user subscribed to SMS through a checkout gist.
DIRECTIndicates that a user subscribed to SMS through a mobile onsite sign-up unit.
DOUBLE_OPT_INIndicates that a user subscribed to SMS through a desktop onsite sign-up unit.
DOUBLE_OPT_IN_AFFILIATEIndicates that a user subscribed to SMS through the Add Subscribers API.
MANUALIndicates that a user subscribed to SMS through a manual upload.
(blank): if blank in this fieldThis is blank for everything except EMAIL_SAVE & JOIN events.

Subscription_type

ValueDefinition
MARKETINGIndicates that a user consented to receiving marketing SMS campaigns from Attentive. This is specifically used for OPT_OUT events.
TRANSACTIONALIndicates that a user consented to receiving transactional SMS (messages about the status of their order) from Attentive. This is specifically used for OPT_OUT events.
(blank)This is blank for non-OPT_OUT events.

Message_type

ValueDefinition
AUTOMATEDIndicates if the message received by the subscriber was an automated journey message (Welcome, Legal, or Triggered).
AUTOMATED_TRANSACTIONALIndicates if the message received by the subscriber was an automated transactional message.
AUTO_RESPONSEIndicates that the message received by the subscriber was an auto-responder (auto-response, already subscribed response).
CONFIRM_OPT_INIndicates that the message received by the subscriber was the Reply “Y” message, asking them to complete the opt in.
CUSTOMER_SERVICEIndicates that the message received by the subscriber was triggered by a customer service integration.
FUZZY_OPT_OUTIndicates that the message received by the subscriber was triggered by a fuzzy opt out keyword and it provided the subscriber the reply “STOP” messaging.
HELPIndicates that the message received by the subscriber was triggered by sending the "HELP" keyword and it provided support information.
ONE_TIMEIndicates if the message received by the subscriber was a one-time campaign message, scheduled within the Attentive platform.
OPT_OUTIndicates that the message received by the subscriber confirmed their opt out from messaging.
SUBSCRIBER_COUPONIndicates that the message received by the subscriber was a copy of their coupon code from the Coupon Delivery Screen.
(blank): if blank in this fieldThis is blank for non-message-based events

Message_Subtypes

ValueDefinition
LEGALRefers to the legal disclaimer message a user receives when subscribing to Attentive. This is only present when Message Type is AUTOMATED.
OTHERRefers to other automated-type messages, including triggered messages (such as Cart Abandonment messages). This is only present when Message Type is AUTOMATED.
WELCOMERefers to the welcome message a user receives when subscribing to Attentive. This is only present when Message Type is AUTOMATED.
(blank): if blank in this fieldThis is blank for ONE_TIME messages, as well as for non-message-based events.

Creative_type

ValueDefinition
DESKTOPIndicates that a user subscribed to SMS through a desktop onsite sign-up unit.
ON_SITEIndicates that a user subscribed to SMS through a mobile onsite sign-up unit.
TEXT_TO_JOINIndicates that a user subscribed to SMS through a Text-to-Join keyword.
INTEGRATIONIndicates that the event is associated with the Add Subscribers API or a checkout gist.
LANDING_PAGEIndicates that the event is associated with an Attentive landing page.
MANUAL_UPLOADIndicates that the event is associated with a manual upload.
(blank): if blank in this fieldThis is blank for non-subscriber events.

Creative_subtype

ValueDefinition
AFFILIATE_ENDPOINTIndicates that the event is associated with the Add Subscribers API.
BUBBLE_FULL_SCREENIndicates that the event is associated with an onsite bubble that expands to a fullscreen creative. This is an SMS only creative.
BUBBLE_PARTIALIndicates that the event is associated with an onsite bubble that expands to a partial creative. This is an SMS only creative.
CODEIndicates that the event is associated with a "Text to Join" keyword.
EMAIL_BUBBLE_FULL_SCREENIndicates that the event is associated with an onsite bubble that expands to a fullscreen creative. This is an email + SMS creative.
EMAIL_BUBBLE_PARTIALIndicates that the event is associated with an onsite bubble that expands to a partial creative. This is an email + SMS creative.
EMAIL_FULL_SCREENIndicates that the event is associated with an onsite fullscreen creative. This is an email + SMS creative.
EMAIL_PARTIALIndicates that the event is associated with an onsite partial creative. This is an email + SMS creative.
FULL_SCREENIndicates that the event is associated with an onsite fullscreen creative. This is an SMS only creative.
NO_SHOWIndicates that the event is associated with a no show creative (nothing shown onsite to the user). This creative subtype is often used for A/B tests.
PARTIALIndicates that the event is associated with an onsite partial creative. This is an SMS only creative.
RECHARGE_CHECKOUT_TRANSACTIONALIndicates that the event is associated with a ReCharge transactional gist.
SHOPIFY_CHECKOUTIndicates that the event is associated with a Shopify marketing gist.
SHOPIFY_CHECKOUT_TRANSACTIONALIndicates that the event is associated with a Shopify transactional gist.
(blank): if blank in this fieldThis will be blank for non-subscriber events.