Emit event
Create a behavior event. This will trigger matching campaigns to offer rewards to the customer.
curl --request POST \
--url https://app.masivo.ai/api/storefront/v1/behavior/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"customer_id": "<string>",
"brand_id": "<string>",
"type": "PURCHASE",
"order": {
"purchase_id": "<string>",
"channel_id": "<string>",
"store_id": "<string>",
"value": 20.95,
"discounted_value": 10.95,
"products": [
{
"sku": "<string>",
"amount": 123,
"value": 123,
"discounted_value": 123,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {}
}
],
"shipping": {
"value": 3.25,
"discounted_value": 2.25,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {}
},
"payment_method": "CREDIT",
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"metadata": {}
},
"fulfilled": true,
"reserve": 1,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {}
}'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "PURCHASE",
"data": {},
"fulfilled": true,
"reserve": 123,
"queue_message_id": "<string>",
"rewarding_campaigns": [
"<any>"
],
"status": "PENDING",
"result": {},
"issued_at": "2023-11-07T05:31:56Z",
"processing_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"expired_at": "2023-11-07T05:31:56Z",
"reversed_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The customer unique identifier in your system
The id of the brand that originate the event
The type of the event
"PURCHASE"
The order in case of a PURCHASE event
The id of a placed order in your system
The order total or subtotal
20.95
The order total or subtotal after discounts
10.95
The product sku
The quantity of the product
The total or subtotal of the product
The total or subtotal of the product after discounts
Include your conditions event tags here
Include any additional info here
The payment method used in the order
CREDIT, DEBIT, CASH, BANK_TRANSFER, OTHER The channel unique identifier in your system
The store unique identifier in your system
The shipping information of the order
The shipping cost
3.25
The shipping cost after discounts
2.25
Include your conditions event tags here
Include any additional info here
The metadata of the order
If the event was fulfilled, when false, rewards to be redeemed will be reserved until fulfilled
The number of days to reserve the rewards
Include your conditions event tags here
Include any additional info here
Response
The event internal unique identifier
The customer id of the event
The type of the event
"PURCHASE"
The data used in the event
If the event was fulfilled.
The number of days to reserve the rewards
The message id in the queue
The campaigns that rewarded the event including the rules that matched
The status of the event
PENDING, PROCESSING, FAILED, RESOLVED, CANCELLED, EXPIRED, REVERSED The result of the event
The date when the event was issued
The date when the event was processed
The date when the event was resolved either succeed or failed
The date when the event was cancelled
The date when the event expired
The date when the event was reversed
curl --request POST \
--url https://app.masivo.ai/api/storefront/v1/behavior/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"customer_id": "<string>",
"brand_id": "<string>",
"type": "PURCHASE",
"order": {
"purchase_id": "<string>",
"channel_id": "<string>",
"store_id": "<string>",
"value": 20.95,
"discounted_value": 10.95,
"products": [
{
"sku": "<string>",
"amount": 123,
"value": 123,
"discounted_value": 123,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {}
}
],
"shipping": {
"value": 3.25,
"discounted_value": 2.25,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {}
},
"payment_method": "CREDIT",
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"metadata": {}
},
"fulfilled": true,
"reserve": 1,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {}
}'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "PURCHASE",
"data": {},
"fulfilled": true,
"reserve": 123,
"queue_message_id": "<string>",
"rewarding_campaigns": [
"<any>"
],
"status": "PENDING",
"result": {},
"issued_at": "2023-11-07T05:31:56Z",
"processing_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"expired_at": "2023-11-07T05:31:56Z",
"reversed_at": "2023-11-07T05:31:56Z"
}
}