Skip to main content

How: I communicate my customer interactions through the API

Ramón avatar
Written by Ramón
Updated over a year ago

📌 Once you have obtained the access token , you can now record interactions of your clients in RAY through the API.

Service

Information must be registered through this service:

POST https://api.rayapp.io/events/interaction

Input message structure

General structure

As input, a list of events is accepted, where each event has associated client information.

[

{

"customProps": {

<ver detalle para cada tipo de evento particular>

},

"storeId": <storeId>,

"subType": "<subtype>",

"type": "<type>",

"source": "OTHER",

"timestamp": "2020-08-05T18:38:13.343Z",

"user": {

"email": "string",

"phone": "string",

"name": "string",

"lastName": "string",

"gender": "string",

"birthDate": "2020-08-05T18:38:13.344Z",

"googleProfile": "string",

"instagramProfile": "string",

"linkedInProfile": "string",

"facebookProfile": "string",

"twitterProfile": "string"

}

}

]

The fields in bold are mandatory

customProps

It depends on the type of event. See section for each particular event

type y subtype

It depends on the type of event. See section for each particular event

source

Always send OTHER value

storeId

Store ID where the user and event must register

timestamp

Date and time the event occurred

user.email

User email address

(*) is required if user.phone is not sent

user.phone

User's phone

(*) is required if user.email is not sent

user.name

User name

user.lastName

User's last name

user.gender

M: masculine
F: feminine

Or: others

user.birthDate

Client's date of birth

user.country

Customer country according to ISO 3166-1-alpha-2 standard ( https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 )

instagramProfile

User profile URL on Instagram

linkedInProfile

URL of the user's profile on linkedin

facebookProfile

Facebook user profile URL

twitterProfile

User profile URL on Twitter

googleProfile

URL of the user's profile in google

💡 Specific data according to the interactions you wish to communicate

Response message structure

A return code of 200 indicates successful operation. If there are validation or permission errors, they will be indicated in the message field and the statusCode will be different than 200.

{

"message": "string",

"result": "success",

"statusCode": 200

}

In case of service unavailability or connectivity errors, retries can be made on the client application side.


​Related articles

Visit our Help Center , there you will find more information to continue learning about the platform.


What do you think of this article? 👇

Did this answer your question?