Required Information
In order to enable the Mobile App Push channel within the platform, you will need to provide the items listed below to your implementation team.
A human readable app name
App- specific information
for iOS apps:
{
"appleSigningKey": ".....kXqU8wHJDAHlEF6w3+ghatjEwnaXve9bASgCgYIKoZIzj0DAQ....",
"appleSigningKeyId": "159VOWLD792",
"appleTeamIdentifier": "KCO6M9L3WK",
"appleBundleIdentifier": "com.clientAppName.example"
}for Android apps:
FCM (Firebase Cloud Messaging) Authentication Token Json File - this can be generated and obtained in the Google Cloud Messaging portal (also accessible via the Firebase console project settings view, under Cloud Messaging).
Go to Service Accounts, choose the account, then go to Keys > Add Key. This will return a token as a Json file to be downloaded.
⚠️ You must have native mobile app source code that your team fully controls in order to integrate with App Push. Third-party apps (e.g. Tapcart) are not supported at this time.
Mobile App Push API Documentation
All API documentation can be accessed within the platform by navigating to Help & Support > REST API Reference or access the Mobile Client REST API here.
💡 Listrak will provide an API key as part of the setup process.
Mobile Client API Endpoint Summary
The API documentation above provides full details on the available mobile endpoints. A summary of their uses is also listed below.
/device POST
Used to create a new Listrak device and generate a DeviceUid. This DeviceUid will then be used as the unique identifier for all other calls to this service. Use this endpoint to register a new device with the Mobile Client API. This can be used to create a device and subscribe it to push notifications in one step. It can optionally include identifier information such as email and phone.
/device/{deviceUid} GET
Used to get the device information of an entire device with a DeviceUid that corresponds with the provided deviceUid. Returns the DeviceUid, DeviceToken, DevicePlatformType, Identifiers (Email and Phone), and Subscribed status of the Device.
/device/{deviceUid} PUT
Use to update an entire device. All data passed along will be updated in the system including identifier data such as email and phone as well as the device token. Use this if there has been a sweeping change to the device, or if you want to ensure that all data is up to date.
/device/{deviceUid} PATCH
This endpoint can be used to update a single, or multiple, pieces of data for a device. It can be used to update identity info such as email and phone as well as the device token.
/device/{deviceUid}/engagement POST
Use to post engagement metrics about a send, such as tapped or dismissed events.