User Guide

Configuring App Inbox for Websites

Suggest Edits

Setting up App Inbox for websites includes:

  1. Getting authentication token.
  2. Script installation and initialization.
  3. Integration of a widget displayed on the site.

📘

Note

App Inbox functionality works only for users authorized on the site.

Getting Authentication Token

Send the request from your backend to Reteno API to receive the authentication token (authToken).
Authenticate the request using one of the methods specified in the API instructions, for example, using an API key.

Request methodPOST
URLhttps://reteno.com/v1/auth/contact/token
Request headerContent-Type: application/json
Request body{
"email": string,
"phone": string,
"externalCustomerId": string
}
Response: HTTP 200{
"token": "string"
}

The request has to contain the known contact fields: email, phone, externalCustomerId (at least one field is required). Those fields are used for searching a contact in Reteno. Afterward, the script uses authToken in requests to the Reteno server.

You can find additional information about managing contacts in API methods for adding contacts.

📘

Important

The token can become invalidated at any moment for security considerations, so you get it more than once. The script renews the token automatically by calling getAuthTokenCallback.
If a contact is not in the Reteno system, the token is not returned, and the following response comes back instead:

{
"token": ""
}

Script Installation and Initialization

Install and initialize the script on your frontend. Transmit getAuthTokenCallback in the parameters. This shall have the function calling your backend and returning the token.

If you have installed the Reteno script to work with web tracking, forms and recommendations, you don’t need to reinstall it. Just add parameters for App Inbox to the initialization call.

Example:

eS('init', {RECOMS: true, TRACKING: false, APP_INBOX: true}, {getAuthTokenCallback: () => yourImplementationOfAuthCallback(),  language: 'en', });

📘

Important

Call the 'init' initialization command one time at every page loading.

If you have not installed the script before, contact the Reteno support team to get it, indicating that you need it for App Inbox.

You can get the script by yourself in the Settings > Web Tracking section.

Reteno's settings

You can learn how to set up a web tracking code here.

Important: Modify the call of the 'init' command in the script generated in the Web Tracking section as follows:
instead of

eS('init')

it has to be

eS('init', {APP_INBOX: true}, {getAuthTokenCallback: () =>yourImplementationOfAuthCallback(),  language: 'en', });

Example of a script with initialization:

<script> !function (t, e, c, n) {var s = e.createElement(c); s.async = 1, s.src = 'https://statics.esputnik.com/scripts/' + n + '.js'; var r = e.scripts[0]; r.parentNode.insertBefore(s, r); var f = function () {f.c(arguments); }; f.q = []; f.c = function () {f.q.push(arguments); }; t['eS'] = t['eS'] || f; }(window, document, 'script', 'UUID'); </script><script>eS('init', {APP_INBOX: true}, {getAuthTokenCallback: () => yourImplementationOfAuthCallback(), language: 'en', });</script>

Parameters of the Object Passed to Reteno Function

NameExampleDescription
getAuthTokenCallbackfunction yourImplementationOfAuthCallback() {
return new Promise((resolve, reject) => {
// place here code with your backend API request, parse token from response and pass it to resolve function call
resolve('token should be placed here');
});
}
Required

type: () => Promise		Asynchronous function called by the script to get authToken. It has to address to the Customer Backend and return Promise
languageen
Required
Type: String		ISO 639-1

Integration of App Inbox Widget

To integrate the widget on the site, the user has to provide to Reteno:

In addition, you can submit an SVG file with the desired design of the notification icon (Bell button) and the design of notifications.

Also, you can ask Reteno to develop the design of the bell button and notifications for you.

Updated over 1 year ago

What’s Next