First steps
User Data
- Email Builder Review
- Designing your email
- Creating a Synchronized Module
- Setting Responsivity
- Building Smart Containers
- Creating a Gmail Promotions Annotation
- Adding a Rollover Effect
- Adding a Background to an Email
- Adding Anchor Links
- Adding a Video to an Email
- Adding a Table to an Email
- Adding a Custom Font
- Adding Social Media Buttons
- Editing HTML and CSS
- Working with “Images” block
- Using AI in the Email Editor
Omnichannel
- SDK for Mobile Apps
- Managing mobile SDK access keys
- Connecting Mobile App
- Creating a Google Project for Mobile Push Notifications
- Creating Mobile Push Messages
- Setting Up Delivery and Clicks Analytics
- Deep Links and Universal Links
- Scheduled Mobile Push Message
- Sending Test Messages from the Event Debug View
- Setting Up Widgets for Your Site
- Widget Calling
- Storing data from widgets to contact fields
- Using Annoyance Safeguard
- Actions After Form Submission
- Yespo Extension for Google Chrome
- Creating Pop-ups via Google Tag Manager or WordPress
- Sending Yespo Widget Events to Google Analytics
- Replacing Double Opt-In System Workflow
- Setting Up Locations for the Widget Calling Rules
Automation
Personalization
Analytics
- Email Campaign Report
- Web Push Campaign Report
- Viber Campaign Report
- Mobile Push Campaign Report
- App Inbox Campaign Report
- Widget Report
- Triggered Campaign Report
- AMP Campaign Report
- SMS Campaign Report
- Multilingual Campaign Report
- Setting up UTM Tags
- Revenue from Campaigns
- Tracking Campaign Performance in Google Analytics
Multilanguage Campaigns
Events and Behaviour Tracking
Recommendations
API
Security and Compliance
Integration
Configuring App Inbox for Mobile Applications
App Inbox is another option to communicate with your customers provided by our CDP. It allows the delivery of automatic and manual notifications to their accounts in the mobile app.
General description of App Inbox, its application, advantages as compared with other communication channels you may find in this article.
Configuring App Inbox for Mobile Apps
To configure App Inbox, you need to send the requests to
- get an authentication token;
- get the number of unread App Inbox messages;
- get the number of pages with messages;
- get the list of all App Inbox messages in the mobile app;
- get the changed status of App Inbox messages.
Getting Authentication Token
Send the request from your server to our platform's API to receive the user authentication token (authToken). Authenticate the request using one of the methods specified in the API instructions, for example, using an API key.
The request has to contain the known contact fields: email, phone, externalCustomerId (at least one field is required). Those fields are used for searching contacts in our system.
Request method |
POST |
Request URL |
api/v1/auth/contact/token |
Request header |
Content-Type: application/json |
Request body |
|
Response |
|
Afterward, authToken is used for authentication of all App Inbox requests. Pass it in the header of the ES-TOKEN request. The current token becomes invalidated after each request, and the ES-TOKEN response header passes the new one used in the following request.
If you receive status code 401 as a response to any App Inbox request, resubmit the request to get the token.
Getting the Number of Unread App Inbox Messages
The request permits you to get information about unread messages in the client’s mobile app. You can send this request on a regular basis.
Request method |
GET |
Request URL |
appinbox/v1/messages/count |
Request header |
ES-TOKEN: authToken |
Response header |
ES-TOKEN: newAuthToken |
Response |
|
If count > 0, you shall see the indicator of unread messages.
Getting the List of All App Inbox Messages
The request permits to get in the response the list of messages in the mobile app, including the following data:
- message ID;
- date of creation;
- header;
- message text content;
- image URL;
- link URL;
- message status (read or unread).
Request method |
GET |
Request URL |
appinbox/v1/messages?page={pageNumber}&pageSize={pageSize} |
Request header |
ES-TOKEN: authToken |
Response header |
ES-TOKEN: newAuthToken |
pageNumber | minimum value 0 |
pageSize | minimum value 1 |
Response |
|
If pageNumber or pageSize is not set then return all actual messages.
Getting the Changed Status of App Inbox Messages
The request transfers the read message event. It is required to pass only the message IDs having newMessage=true.
Using this request, you also can change the status of all messages from "unread" to "read".
Request method |
POST |
Request URL |
appinbox/v1/messages/status |
Request header |
ES-TOKEN: authToken |
Response header |
ES-TOKEN: newAuthToken |
Request body |
To pass the "message read" event:
To change the status of all messages to "read":
|
Response |
none |
Creating App Inbox Messages
See this article to learn more about creating the messages and campaigns.