Receive Event

Production

POST

https://api.b2b.retter.io/5p1hp1d2t/CALL/LoyaltyAPI/receiveEvent

Loyalty

Last modified:2024-09-17 11:22:35

ReceiveEvent method initially records events in the database and subsequently triggers the loyalty rule actions related to the respective event, if such actions exist.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

entityId

string

required

Example: User-1

entityType

string

required

Example: USER

entityData

object

optional

name

string

optional

Example: John

surname

string

optional

Example: Doe

referenceId

string

optional

Example: 123477849904y3t3t

eventType

string

required

Example: EARNING

eventData

object

optional

transactionId

string

optional

amount

integer

optional

currency

string

optional

Example: POINT

webhook

boolean

optional

Example: true

measurements

array [object {5}]

optional

measurement

string

optional

Example: AMOUNT

value

integer

optional

groupeName

string

optional

groupeValue

string

optional

time

string

optional

Ex: 2024-09-04T13:14:43.779Z
If not provided, event time is taken.

Example:

2024-09-04T13:14:43.779Z

time

string

optional

EX: 2024-09-04T13:14:43.779Z
If not provided, now is taken.

Example

{
  "entityId": "string",
  "entityType": "string",
  "entityData": {
    "name": "string",
    "surname": "string"
  },
  "referenceId": "string",
  "eventType": "string",
  "eventData": {
    "transactionId": "string",
    "amount": 0,
    "currency": "string",
    "webhook": true
  },
  "measurements": [
    {
      "measurement": "string",
      "value": 0,
      "groupeName": "string",
      "groupeValue": "string",
      "time": "2024-09-04T13:14:43.779Z"
    }
  ],
  "time": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.b2b.retter.io/5p1hp1d2t/CALL/LoyaltyAPI/receiveEvent' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw ''

Responses

🟢200OK

application/json

Body

eventId

string

optional

Example

{
  "eventId": "string"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

Modified at 2024-09-17 11:22:35

Get Active Promotions

Calculate