- 13 May 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
Events
- Updated on 13 May 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
Events
Bento provides event driven updates about the status of various entities from within the Bento platform.
This capability provides you with the ability to:
Create a replica of the current Bento state - Ability driving internal analytics platforms or existing internal processes require information about the current state that customers and their subscriptions and orders are in.
Drive third-party platforms off the back of Bento changes - Whilst Bento supports a number of third party platforms via integrations and Bring Your Own Platform, the ecosystem is large and ever growing. As such the Event Notifications system can be used to integrate with platforms beyond those currently supported.
Description | Link | |
---|---|---|
Order | Event driven updates about the status of an order within Bento Box. | |
Subscription | Event driven updates about the status of a subscription within Bento Box. |
Event Wrapping
Each event body is wrapped with useful information about the event, so for an example an order refunded event could look like the following:
{
"eventId": "81aa853b-4f09-4ecd-9404-85ac02a0997c",
"version": 1,
"eventType": "order",
"eventAction": "refunded",
"emittedAt": "2024-04-11T04:23:23.719Z",
"tenantId": "1245abcdefg",
"body": {
"creditParams": {
"creditAmount": 5,
"customerId": "5275",
"subscriptionId": "81aa853b-4f09-4ecd-9404-85ac02a0997c"
},
"orderId": "1587",
"type": "credit"
}
}