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.
pushmessages_<company_key>_<date>.<extension>
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 Name | Data Type | Field Length | Allows Nulls | Description |
|---|---|---|---|---|
| person_id | String | 255 | No | Unique Vibes-specified GUID representing the person Note that while the field is labeled person_id, the value is the person_key. |
| external_person_id | String | 255 | Yes | External system's person identifier |
| vibes_device_id | String | 255 | Yes | Vibes unique identifier for each device |
| os | String | 10 | No | Operating system of the push device (Android or IOS) |
| push_token | String | 255 | Yes | Android or iOS Push token |
| message_id | String | 255 | No | Unique message ID defined by Vibes |
| client_message_id | String | 255 | Yes | Unique message ID defined by a client |
| receipt_at | Date/Time | N/A | No | Date and time push message received |
| response_text | String | 255 | Yes | The response text: Success, Unregistered, or DeviceTokenNotForTopic |
| activity_type | String | 255 | Yes | Type of campaign r activity the message is associated with (Push, Broadcast, Acquisition, and so on). See a full list of activity types here. |
| activity_id | String | 255 | Yes | ID of the activity the push message is associated with |
| company_id | String | 255 | No | ID of the company |
| app_id | String | 255 | No | ID of the mobile app |
| content | String | 1000 | Yes | The content of the push message |
| subject | String | 255 | Yes | The subject of the push message |
Example File
Updated about 2 months ago