Events Webhook
What is a Webhook?
A webhook is a mechanism that allows an application to receive real-time events from another application via HTTP requests. Instead of a system polling for new events periodically, the webhook automatically sends the information when a relevant event occurs.
What Does Your Webhook Do?
Your webhook will receive the different events generated from our platform in order to perform different actions based on your needs.
The general workflow is as follows:
- Our platform generates an event.
- The event processing service process messages and determines which events should be retransmitted based on the triggers configured.
- If an event needs to be sent to a client, the system executes the corresponding webhook, notifying the client's application in real-time.
Examples
1. Member Created (member-created)
- When a new member is created in the platform, it generates an event of type
member-created. - The platform checks if the event should be forwarded based on configured triggers.
- If applicable, the event is sent to the client's application in real-time via an HTTP request.
Example Payload for member-created Webhook
{
"event": {
"loyaltyEventId": "1262268",
"eventType": "member-created",
"status": "success",
"executionResults": {
"tiers": [
{
"loyaltyTierId": 1,
"loyaltyProgramId": 1,
"loyaltyManualTierId": null,
"loyaltySystemTierId": 1
}
],
"active": true,
"onChain": {
"wallets": []
},
"profile": {
"name": "John",
"email": "test-user@email.com",
"govId": {
"id": "94343643",
"type": "DNI",
"issuingCountry": "Ar"
},
"emails": [
"test-user@email.com"
],
"lastName": "Doe",
"birthdate": "2025-04-24T13:20:24.404Z",
"phoneNumber": "541123364526"
},
"createdAt": "2025-04-24T13:22:50.049Z",
"updatedAt": "2025-04-24T13:22:50.049Z",
"organizations": [
{
"active": true,
"createdAt": "2025-04-24T13:22:50.156Z",
"updatedAt": "2025-04-24T13:22:50.156Z",
"loyaltyMemberId": "test-user@email.com",
"publicLoyaltyMemberId": "11111-11111"
}
],
"ledgerWalletId": 16069,
"ledgerWalletKey": "wal_01JSKZE71W1MD7KWS453W9VJDH"
},
"payload": {
"active": true,
"profile": {
"name": "John",
"email": "test-user@email.com",
"govId": {
"id": "94343643",
"type": "DNI",
"issuingCountry": "Ar"
},
"lastName": "Doe",
"birthdate": "2025-04-24T13:20:24.404Z",
"phoneNumber": "541123364526"
},
"loyaltyMemberId": "test-user@email.com",
"publicLoyaltyMemberId": "11111-11111"
},
"externalEventDate": null,
"evaluationStatus": 0,
"systemUniqueKey": "8952c2f4-d76f-40f3-890d-aef3af273356",
"loyaltyEventKey": "ev_01JSKZG24NMDB0RRQHF247NSCX",
"updatedAt": "2025-04-24T13:23:50.586Z",
"createdAt": "2025-04-24T13:23:50.586Z",
"externalId": null,
"lastError": null,
"description": null,
"tags": null,
"evaluationResults": null
}
}
2. Coupon Code Assignment (coupon-code-assigned)
- When a coupon code is assigned to a user, an event is sent with the type
coupon-code-assigned, indicating that a coupon has been successfully assigned.
Example Payload for coupon-code-assigned Webhook
{
"event": {
"eventType": "coupon-code-assigned",
"loyaltyEventKey": "ev_01JSG9YM0YZHBS9X3G0VMVMAW6",
"updatedAt": "2025-04-23T03:09:35.646Z",
"createdAt": "2025-04-23T03:09:35.646Z",
"systemUniqueKey": "6efee6f7-2128-4f9b-9d0e-9d771a4a8dec",
"loyaltyMemberId": "11111111",
"status": "success",
"executionResults": {
"coupon": {
"code": "PyMsNLgHR3yfMQAAc11viQ",
"createdAt": "2025-04-23T03:08:29.976Z",
"expiredAt": "2025-06-23T01:52:32.275Z",
"updatedAt": "2025-04-23T03:08:29.976Z",
"totalUsages": 0,
"totalAssigned": 0,
"couponBookKey": "cbk_01JSG2C0V4AJHVZ6P3E0PQH9EV",
"customAttributes": null
},
"createdAt": "2025-04-23T03:08:30.031Z",
"updatedAt": "2025-04-23T03:08:30.031Z",
"amountUsed": 0,
"amountAssigned": 1,
"couponUsageKey": "cbu_01JSG9WKYEJDKTSKVYABF2WQBC",
"revertedUsageId": null,
"systemUniqueKey": "6efee6f7-2128-4f9b-9d0e-9d771a4a8dec",
"customAttributes": null,
"updatedTotalUsages": 0,
"updatedTotalAssigned": 1
},
"payload": {
"usage": {
"coupon": {
"code": "PyMsNLgHR3yfMQAAc11viQ",
"couponBookKey": "cbk_01JSG2C0V4AJHVZ6P3E0PQH9EV",
"createdAt": "2025-04-23T03:08:29.976Z",
"expiredAt": "2025-06-23T01:52:32.275Z",
"updatedAt": "2025-04-23T03:08:29.976Z",
"totalUsages": 0,
"totalAssigned": 0,
"customAttributes": null
},
"createdAt": "2025-04-23T03:08:30.031Z",
"updatedAt": "2025-04-23T03:08:30.031Z",
"amountUsed": 0,
"amountAssigned": 1,
"couponUsageKey": "cbu_01JSG9WKYEJDKTSKVYABF2WQBC",
"revertedUsageId": null,
"systemUniqueKey": "6efee6f7-2128-4f9b-9d0e-9d771a4a8dec",
"loyaltyMemberId": "11111111",
"customAttributes": null,
"updatedTotalUsages": 0,
"updatedTotalAssigned": 1
},
"couponBook": {
"couponBookKey": "cbk_01JSG2C0V4AJHVZ6P3E0PQH9EV",
"name": "Test discount",
"type": "generated",
"externalId": "Y6QF-TEST",
"pictureUrl": "https://example.com/coupon-image.png",
"description": "<p>Test discount description</p>",
"validToDate": null,
"validFromDate": null,
"discountType": "percentage",
"discountAmount": 20,
"tags": null,
"customAttributes": null
}
},
"externalEventDate": null,
"evaluationStatus": 0,
"externalId": null,
"lastError": null,
"description": null,
"tags": null,
"evaluationResults": null
}
}
3. Coupon Code Usage (coupon-code-used)
- When a user uses a coupon, an event is sent with the type
coupon-code-used, indicating that a coupon has been redeemed successfully.
Example Payload for coupon-code-used Webhook
{
"event": {
"eventType": "coupon-code-used",
"loyaltyEventKey": "ev_c11viQYM0YZHBS9X3G0VMVyfMQ",
"updatedAt": "2025-04-23T03:09:35.646Z",
"createdAt": "2025-04-23T03:09:35.646Z",
"systemUniqueKey": "6efee6f7-2128-4f9b-9d0e-9d771a4a8dec",
"loyaltyMemberId": "11111111",
"status": "success",
"executionResults": {
"coupon": {
"code": "PyMsNLgHR3yfMQAAc11viQ",
"createdAt": "2025-04-23T03:08:29.976Z",
"expiredAt": "2025-06-23T01:52:32.275Z",
"updatedAt": "2025-04-23T03:08:29.976Z",
"totalUsages": 0,
"totalAssigned": 1,
"couponBookKey": "cbk_01JSG2C0V4AJHVZ6P3E0PQH9EV",
"customAttributes": null
},
"createdAt": "2025-04-23T03:08:30.031Z",
"updatedAt": "2025-04-23T03:08:30.031Z",
"amountUsed": 1,
"amountAssigned": 1,
"couponUsageKey": "cbu_01JJQ1KNAEV5E0RVZPE0E27AR7",
"revertedUsageId": null,
"systemUniqueKey": "6efee6f7-2128-4f9b-9d0e-9d771a4a8dec",
"customAttributes": null,
"updatedTotalUsages": 1,
"updatedTotalAssigned": 1
},
"payload": {
"usage": {
"coupon": {
"code": "PyMsNLgHR3yfMQAAc11viQ",
"couponBookKey": "cbk_01JSG2C0V4AJHVZ6P3E0PQH9EV",
"createdAt": "2025-04-23T03:08:29.976Z",
"expiredAt": "2025-06-23T01:52:32.275Z",
"updatedAt": "2025-04-23T03:08:29.976Z",
"totalUsages": 0,
"totalAssigned": 1,
"customAttributes": null
},
"createdAt": "2025-04-23T03:08:30.031Z",
"updatedAt": "2025-04-23T03:08:30.031Z",
"amountUsed": 1,
"amountAssigned": 1,
"couponUsageKey": "cbu_01JSG9WKYEJDKTSKVYABF2WQBC",
"revertedUsageId": null,
"systemUniqueKey": "6efee6f7-2128-4f9b-9d0e-9d771a4a8dec",
"loyaltyMemberId": "11111111",
"customAttributes": null,
"updatedTotalUsages": 1,
"updatedTotalAssigned": 1
},
"couponBook": {
"couponBookKey": "cbk_01JSG2C0V4AJHVZ6P3E0PQH9EV",
"name": "Test discount",
"type": "generated",
"externalId": "Y6QF-TEST",
"pictureUrl": "https://example.com/coupon-image.png",
"description": "<p>Test discount description</p>",
"validToDate": null,
"validFromDate": null,
"discountType": "percentage",
"discountAmount": 20,
"tags": null,
"customAttributes": null
}
},
"externalEventDate": null,
"evaluationStatus": 0,
"externalId": null,
"lastError": null,
"description": null,
"tags": null,
"evaluationResults": null
}
}