Push Message Extract

The daily Push Message Extract is used to sync push message data between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system.

Standard File Name

The following is the recommended best practice for file names. File naming conventions may be changed upon request.


How to Read Files

Extract files will be delivered in tab-separated value (TSV) text files. The information is separated into rows and columns. Column data will be separated by tabs, while each new row will be separated by a hard return.

The push message field is quoted with double quotes. Any double quotes within the push message body will be escaped with two double quotes.

Content of Each File

Each row represents a push notification sent by the platform to a device.

File Body

The file body can contain the following fields as data, separated by the delimiter and a header row.

Field NameData TypeField LengthAllows NullsDescription
person_idString255NoUnique Vibes-specified GUID representing the person

Note that while the field is labeled person_id, the value is the person_key.
external_person_idString255YesExternal system's person identifier
vibes_device_idString255YesVibes unique identifier for each device
osString10NoOperating system of the push device (Android or IOS)
push_tokenString255YesAndroid or iOS Push token
message_idString255NoUnique message ID defined by Vibes
client_message_idString255YesUnique message ID defined by a client
receipt_atDate/TimeN/ANoDate and time push message received
response_textString255YesThe response text: Success, Unregistered, or DeviceTokenNotForTopic
activity_typeString255YesType of campaign r activity the message is associated with (Push, Broadcast, Acquisition, and so on). See a full list of activity types here.
activity_idString255YesID of the activity the push message is associated with
company_idString255NoID of the company
app_idString255NoID of the mobile app
contentString1000YesThe content of the push message
subjectString255YesThe subject of the push message

Example File