Receiving the user context

If you have already submitted a place list and one of our customer success managers has already enabled the Enterprise Integrations functionality, you will begin to receive context events at your CRM endpoint. 🚀

​⬇Receiving events

The Inloco SDK notifies the Inloco backend of the event occurrence. The event is enhanced with context data and it is verified against the predefined list of places. If any match is observed, a request is then generated to your endpoint.

​🧠Note: Notice that only users who have given proper consent will have their visits collected.

A payload example abot what Inloco will send to your endpoint looks as follows:

JavaScript
JavaScript
{
"user_id": "8f8fb478-dad0-4963-b8ff-32d8e8afc150",
"timestamp": 1580322710000,
"context": {
"region": "São Paulo",
"moment": "on_visit",
"where": "at",
"categories": ["restaurant"],
"name": "Ristorante"
}
}

Let's explain each one of these fields.

Field

Type

Description

user_id

string

Id of users on your system.

timestamp

long

Time when event was generated (notation in unix time, in milliseconds).

context

object

Content with context extracted from visit.

region

string

City where user was during match.

moment

enum

("on_visit", "on_exit")

Moment when data was collected.

where

enum

("at")

Specifies how close, related to a place of interest, the user was.

categories

array

(string)

Categories of visited place, except blacklisted categories.

name

string

Name of the list in which visited place is configured.

​🧠Note: We will send the token you sent us during the activating the feature step as a Header field called x-api-token.