Receive Event

Production

https://api.mircate.com/5p1hp1d2t

POST

/CALL/LoyaltyAPI/receiveEvent

Last modified:2025-10-22 10:40:47

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

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.mircate.com/5p1hp1d2t/CALL/LoyaltyAPI/receiveEvent' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "eventId": "68f8b2fe28aa8c91d5f0aa99",
    "entityErrors": {
        "phoneNumber": [
            "0 is not a string."
        ],
        "birthDate": [
            "Incorrect Date is not a valid date."
        ],
        "gdprOptin": [
            "Wrong Type is not a boolean."
        ],
        "registrationType": [
            "Invalid type is not a valid option."
        ]
    },
    "eventErrors": {
        "orderId": [
            "1234 is not a string."
        ],
        "rate": [
            "number is not a number."
        ]
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-10-22 10:40:47

Get Active Promotions

Cancel Event