Prize Events

Prize Awarded

Raised when a prize is awarded to a user for a given data capture.

Example data

{"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "PrizeAwarded",
"timestamp": "2000-01-01T00:00:00.000Z",
// null
// "Site"
"site_id": "2d5776b8-158a-4216-aaa1-edbc249e005b",
"site_name": "My site",
// "Card"
"card_id": "dd0b77cd-35ca-404e-8b23-1d86a7471f78",
"card_name": "card name",
"card_type": "Quiz",
"score": "1",
"correct": "1",
// "Prize"
"prize_recipient_id": "39875c41-ab5b-44dd-9d2a-2818ba5acea3",
"prize_id": "3c5f45f3-5b63-4365-94a3-1b4889b179a5",
"prize_name": "First Prize",
// "Session"
"user_session_id": "d40cc0e7-7243-4060-a75f-b2062c94462a",
// "User account (if accounts are enabled)"
"user_profile_id": "0fdbb943-511c-4220-9266-31465374f43b",
"User attributes": "",
// "Any user attributes captured for the session/account will be added as well"
"competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015",
// "Data capture fields"
"submission_id": "c0ff823d-c8bf-4858-90b4-d536fe55b902",
"optin": "true"
}

Name	Type	Description	Required
site_id	`UUID`	A UUID identifier which uniquely represents an active site.	Required
site_name	`String`	The name of the given site.	Required
card_id	`UUID`	The unique Id for the card.	Required
card_name	`String`	The name of the card indicated by the internal name listed on the card.	Required
card_type	`String`	The type of card that this event was triggered from.	Required
score	`Number`	The total number of points for the gameplay.	Required
correct	`Number`	The total number questions that the gameplay got correct.	Required
prize_recipient_id	`UUID`	A UUID identifier which uniquely identifies a prize recipient.	Required
prize_id	`UUID`	A UUID identifier which uniquely identifies the prize.	Required
prize_name	`String`	The name of the prize.	Required
user_session_id	`UUID`	A UUID identifier which uniquely represents an active user session.	Required
user_profile_id	`UUID`	A UUID 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
competition_entry_id	`UUID`	The unique UUID identifier of an entry of a competition for a given card.	Required
submission_id	`UUID`	A UUID identifier that uniquely identifies an instance of a data capture form submission.	Required
optin	`String`	Whether the user opted in.	Required