Skip to Content
EventsCoupons

Coupon events

Events relating to coupons

Coupon Issued

Beta

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
}
NameTypeDescriptionOptional
id
GUID
A unique GUID identifier of the corresponding component
False
event
String
An event name indicating the type of event that is being raised
False
timestamp
TimeStamp
A timestamp indicating when the corresponding component was created
False
site_id
GUID
A GUID identifier which uniquely represents an active site.
False
site_name
String
The name of the given site.
False
offer_id
GUID
The unique Id of the coupon offer that the coupon is from.
False
coupon_id
GUID
The unique Id of the coupon.
False
offer_name
String
The name given to the coupon offer.
False
coupon_code
Number
The unique code assigned to the coupon.
True
competition_entry_id
GUID
The id linking to the entry that this coupon was awarded from
True
user_session_id
GUID
A GUID identifier which uniquely represents an active user session.
False
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
True
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.
True

Coupon Viewed

Beta

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
}
NameTypeDescriptionOptional
id
GUID
A unique GUID identifier of the corresponding component
False
event
String
An event name indicating the type of event that is being raised
False
timestamp
TimeStamp
A timestamp indicating when the corresponding component was created
False
site_id
GUID
A GUID identifier which uniquely represents an active site.
False
site_name
String
The name of the given site.
False
offer_id
GUID
The unique Id of the coupon offer that the coupon is from.
False
coupon_id
GUID
The unique Id of the coupon.
False
offer_name
String
The name given to the coupon offer.
False
coupon_code
Number
The unique code assigned to the coupon.
True
competition_entry_id
GUID
The id linking to the entry that this coupon was awarded from
True
user_session_id
GUID
A GUID identifier which uniquely represents an active user session.
False
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
True
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.
True

Coupon Redemption Success

Beta

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",
}
NameTypeDescriptionOptional
id
GUID
A unique GUID identifier of the corresponding component
False
event
String
An event name indicating the type of event that is being raised
False
timestamp
TimeStamp
A timestamp indicating when the corresponding component was created
False
site_id
GUID
A GUID identifier which uniquely represents an active site.
False
site_name
String
The name of the given site.
False
user_session_id
GUID
A GUID identifier which uniquely represents an active user session.
False
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
True
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.
True
offer_id
GUID
The unique Id of the coupon offer that the coupon is from.
False
coupon_id
GUID
The unique Id of the coupon.
False
offer_name
String
The name given to the coupon offer.
False
coupon_code
Number
The unique code assigned to the coupon.
True
competition_entry_id
GUID
The id linking to the entry that this coupon was awarded from
True
coupon_location
String
The name of the location that the coupon can be redeemed/used at.
False

Coupon Redemption Error

Beta

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",
}
NameTypeDescriptionOptional
id
GUID
A unique GUID identifier of the corresponding component
False
event
String
An event name indicating the type of event that is being raised
False
timestamp
TimeStamp
A timestamp indicating when the corresponding component was created
False
site_id
GUID
A GUID identifier which uniquely represents an active site.
False
site_name
String
The name of the given site.
False
user_session_id
GUID
A GUID identifier which uniquely represents an active user session.
False
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
True
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.
True
offer_id
GUID
The unique Id of the coupon offer that the coupon is from.
False
coupon_id
GUID
The unique Id of the coupon.
False
offer_name
String
The name given to the coupon offer.
False
coupon_code
Number
The unique code assigned to the coupon.
True
competition_entry_id
GUID
The id linking to the entry that this coupon was awarded from
True
coupon_location
String
The name of the location that the coupon can be redeemed/used at.
False
coupon_redemption_error
String
The error displayed if the coupon has already been redeemed.
False