Coupon Events
Events relating to coupons
Coupon Issued
Raised when a coupon is issued to a user.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "CouponIssued", "timestamp": "2000-01-01T00:00:00.000Z", // Site "site_id": "2d5776b8-158a-4216-aaa1-edbc249e005b", "site_name": "My site", // Coupon "offer_id": "9620376e-1ed9-4333-81c6-68b2188fda5a", "coupon_id": "a713a50d-e095-4446-b9e7-c473f514291f", "offer_name": "10% off your next coffee", "coupon_code": "12345", "competition_entry_id": "05f267de-0347-4266-970d-cb6a58fecc36", // Session "user_session_id": "d40cc0e7-7243-4060-a75f-b2062c94462a", // User account (if accounts are enabled) "user_profile_id": "0fdbb943-511c-4220-9266-31465374f43b", // Any user attributes captured for the session/account will be added as well}| Name | Type | Description | Required |
|---|---|---|---|
| id | GUID | A unique GUID identifier of the corresponding component | Required |
| event | String | An event name indicating the type of event that is being raised | Required |
| timestamp | TimeStamp | A timestamp indicating when the corresponding component was created | Required |
| site_id | GUID | A GUID identifier which uniquely represents an active site. | Required |
| site_name | String | The name of the given site. | Required |
| offer_id | GUID | The unique Id of the coupon offer that the coupon is from. | Required |
| coupon_id | GUID | The unique Id of the coupon. | Required |
| offer_name | String | The name given to the coupon offer. | Required |
| coupon_code | Number | The unique code assigned to the coupon. | Optional |
| competition_entry_id | GUID | The id linking to the entry that this coupon was awarded from | Optional |
| user_session_id | GUID | A GUID identifier which uniquely represents an active user session. | Required |
| user_profile_id | GUID | A GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed in | Optional |
| User attributes | String | If the user has a profile all attributes captured for their profile will be attached, if not any attributes captured for the user session will be included. Attributes will be listed as separate key value pairs on the webhook body. | Optional |
Coupon Viewed
Raised when a coupon is viewed by a user. This does not ensure the coupon is redeemed.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "CouponViewed", "timestamp": "2000-01-01T00:00:00.000Z", // Site "site_id": "2d5776b8-158a-4216-aaa1-edbc249e005b", "site_name": "My site", // Coupon "offer_id": "9620376e-1ed9-4333-81c6-68b2188fda5a", "coupon_id": "a713a50d-e095-4446-b9e7-c473f514291f", "offer_name": "10% off your next coffee", "coupon_code": "12345", "competition_entry_id": "05f267de-0347-4266-970d-cb6a58fecc36", // Session "user_session_id": "d40cc0e7-7243-4060-a75f-b2062c94462a", // User account (if accounts are enabled) "user_profile_id": "0fdbb943-511c-4220-9266-31465374f43b", // Any user attributes captured for the session/account will be added as well}| Name | Type | Description | Required |
|---|---|---|---|
| id | GUID | A unique GUID identifier of the corresponding component | Required |
| event | String | An event name indicating the type of event that is being raised | Required |
| timestamp | TimeStamp | A timestamp indicating when the corresponding component was created | Required |
| site_id | GUID | A GUID identifier which uniquely represents an active site. | Required |
| site_name | String | The name of the given site. | Required |
| offer_id | GUID | The unique Id of the coupon offer that the coupon is from. | Required |
| coupon_id | GUID | The unique Id of the coupon. | Required |
| offer_name | String | The name given to the coupon offer. | Required |
| coupon_code | Number | The unique code assigned to the coupon. | Optional |
| competition_entry_id | GUID | The id linking to the entry that this coupon was awarded from | Optional |
| user_session_id | GUID | A GUID identifier which uniquely represents an active user session. | Required |
| user_profile_id | GUID | A GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed in | Optional |
| User attributes | String | If the user has a profile all attributes captured for their profile will be attached, if not any attributes captured for the user session will be included. Attributes will be listed as separate key value pairs on the webhook body. | Optional |
Coupon Redemption Success
Raised when a user successfully redeems a coupon.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "CouponRedemptionSuccess", "timestamp": "2000-01-01T00:00:00.000Z", // Site "site_id": "2d5776b8-158a-4216-aaa1-edbc249e005b", "site_name": "My site", // Session "user_session_id": "d40cc0e7-7243-4060-a75f-b2062c94462a", // User account (if accounts are enabled) "user_profile_id": "0fdbb943-511c-4220-9266-31465374f43b", // Any user attributes captured for the session/account will be added as well // Coupon "offer_id": "9620376e-1ed9-4333-81c6-68b2188fda5a", "coupon_id": "a713a50d-e095-4446-b9e7-c473f514291f", "offer_name": "10% off your next coffee", "coupon_code": "12345", "competition_entry_id": "05f267de-0347-4266-970d-cb6a58fecc36", "coupon_location": "Shop 123",}| Name | Type | Description | Required |
|---|---|---|---|
| id | GUID | A unique GUID identifier of the corresponding component | Required |
| event | String | An event name indicating the type of event that is being raised | Required |
| timestamp | TimeStamp | A timestamp indicating when the corresponding component was created | Required |
| site_id | GUID | A GUID identifier which uniquely represents an active site. | Required |
| site_name | String | The name of the given site. | Required |
| user_session_id | GUID | A GUID identifier which uniquely represents an active user session. | Required |
| user_profile_id | GUID | A GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed in | Optional |
| User attributes | String | If the user has a profile all attributes captured for their profile will be attached, if not any attributes captured for the user session will be included. Attributes will be listed as separate key value pairs on the webhook body. | Optional |
| offer_id | GUID | The unique Id of the coupon offer that the coupon is from. | Required |
| coupon_id | GUID | The unique Id of the coupon. | Required |
| offer_name | String | The name given to the coupon offer. | Required |
| coupon_code | Number | The unique code assigned to the coupon. | Optional |
| competition_entry_id | GUID | The id linking to the entry that this coupon was awarded from | Optional |
| coupon_location | String | The name of the location that the coupon can be redeemed/used at. | Required |
Coupon Redemption Error
Raised when a user attempts to redeem a coupon, but is unsuccessful for some reason such as a coupon already being redeemed.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "CouponRedemptionError", "timestamp": "2000-01-01T00:00:00.000Z", // Site "site_id": "2d5776b8-158a-4216-aaa1-edbc249e005b", "site_name": "My site", // Session "user_session_id": "d40cc0e7-7243-4060-a75f-b2062c94462a", // User account (if accounts are enabled) "user_profile_id": "0fdbb943-511c-4220-9266-31465374f43b", // Any user attributes captured for the session/account will be added as well // Coupon "offer_id": "9620376e-1ed9-4333-81c6-68b2188fda5a", "coupon_id": "a713a50d-e095-4446-b9e7-c473f514291f", "offer_name": "10% off your next coffee", "coupon_code": "12345", "competition_entry_id": "05f267de-0347-4266-970d-cb6a58fecc36", "coupon_location": "Shop 123", "coupon_redemption_error": "Already redeemed",}| Name | Type | Description | Required |
|---|---|---|---|
| id | GUID | A unique GUID identifier of the corresponding component | Required |
| event | String | An event name indicating the type of event that is being raised | Required |
| timestamp | TimeStamp | A timestamp indicating when the corresponding component was created | Required |
| site_id | GUID | A GUID identifier which uniquely represents an active site. | Required |
| site_name | String | The name of the given site. | Required |
| user_session_id | GUID | A GUID identifier which uniquely represents an active user session. | Required |
| user_profile_id | GUID | A GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed in | Optional |
| User attributes | String | If the user has a profile all attributes captured for their profile will be attached, if not any attributes captured for the user session will be included. Attributes will be listed as separate key value pairs on the webhook body. | Optional |
| offer_id | GUID | The unique Id of the coupon offer that the coupon is from. | Required |
| coupon_id | GUID | The unique Id of the coupon. | Required |
| offer_name | String | The name given to the coupon offer. | Required |
| coupon_code | Number | The unique code assigned to the coupon. | Optional |
| competition_entry_id | GUID | The id linking to the entry that this coupon was awarded from | Optional |
| coupon_location | String | The name of the location that the coupon can be redeemed/used at. | Required |
| coupon_redemption_error | String | The error displayed if the coupon has already been redeemed. | Required |