Events
Cards
Live trivia

Trivia events

Events from Live Trivia

Live trivia startedBeta

Raised when a user starts a live trivia game.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "TriviaGameplayStarted",
"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
// Card
"card_id": "dd0b77cd-35ca-404e-8b23-1d86a7471f78",
"card_name": "card name",
"card_type": "Trivia",
"trivia_gameplay_id": "a4ae9ccc-712f-4a35-a7fe-938352786541",
"competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015",
}
NameTypeDescriptionOptional
idGuidA unique GUID identifier of the corresponding componentfalse
eventstringAn event name indicating the type of event that is being raisedfalse
timestampTimestampA timestamp indicating when the corresponding component was createdfalse
site_idGuidA GUID identifier which uniquely represents an active site.false
site_namestringThe name of the given site.false
user_session_idGuidA GUID identifier which uniquely represents an active user session.false
user_profile_idGuidA GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed intrue
User attributesstringIf 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
card_idGuidThe unique Id for the card.false
card_namestringThe name of the card indicated by the internal name listed on the card.false
card_typestringThe type of card that this event was triggered from.false
trivia_gameplay_idGuidThe unique id for the users gameplay on the trivia.false
competition_entry_idGuidThe unique GUID identifier of an entry of a competition for a given card.false

Live trivia question answeredBeta

Raised when a user answers a question during a live trivia game.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "TriviaGameplayAnswered",
"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
// Card
"card_id": "dd0b77cd-35ca-404e-8b23-1d86a7471f78",
"card_name": "card name",
"card_type": "Trivia",
"trivia_gameplay_id": "a4ae9ccc-712f-4a35-a7fe-938352786541",
"competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015",
// Answer
"question_id": "15ec92cb-b802-4623-a42d-8800aa63f962",
"question_text": "What is 2 + 2?",
"answer_option_id": "569c7bea-a9b6-45b1-a3fe-6382bb83ac50",
"question_answer": "4",
"answer_correct": "true",
}
NameTypeDescriptionOptional
idGuidA unique GUID identifier of the corresponding componentfalse
eventstringAn event name indicating the type of event that is being raisedfalse
timestampTimestampA timestamp indicating when the corresponding component was createdfalse
site_idGuidA GUID identifier which uniquely represents an active site.false
site_namestringThe name of the given site.false
user_session_idGuidA GUID identifier which uniquely represents an active user session.false
user_profile_idGuidA GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed intrue
User attributesstringIf 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
card_idGuidThe unique Id for the card.false
card_namestringThe name of the card indicated by the internal name listed on the card.false
card_typestringThe type of card that this event was triggered from.false
trivia_gameplay_idGuidThe unique id for the users gameplay on the trivia.false
competition_entry_idGuidThe unique GUID identifier of an entry of a competition for a given card.false
question_idGuidThe Id for the question answered.false
question_textstringThe question text.false
answer_option_idGuidThe unique GUID representation for the submitted option.false
question_answerstringThe text that is displayed on the answer selected.true
answer_correctbooleanIf the answer the user selected was correct or not.false

Live trivia finishedBeta

Raised when a user completes a live trivia game.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "TriviaGameplayFinished",
"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
// Card
"card_id": "dd0b77cd-35ca-404e-8b23-1d86a7471f78",
"card_name": "card name",
"card_type": "Trivia",
"trivia_gameplay_id": "a4ae9ccc-712f-4a35-a7fe-938352786541",
"competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015",
}
NameTypeDescriptionOptional
idGuidA unique GUID identifier of the corresponding componentfalse
eventstringAn event name indicating the type of event that is being raisedfalse
timestampTimestampA timestamp indicating when the corresponding component was createdfalse
site_idGuidA GUID identifier which uniquely represents an active site.false
site_namestringThe name of the given site.false
user_session_idGuidA GUID identifier which uniquely represents an active user session.false
user_profile_idGuidA GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed intrue
User attributesstringIf 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
card_idGuidThe unique Id for the card.false
card_namestringThe name of the card indicated by the internal name listed on the card.false
card_typestringThe type of card that this event was triggered from.false
trivia_gameplay_idGuidThe unique id for the users gameplay on the trivia.false
competition_entry_idGuidThe unique GUID identifier of an entry of a competition for a given card.false

Live trivia prize viewedComing soon

Raised when a user returns to view which prize they won after the game was ended.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "TriviaGameplayViewedPrizes",
"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
// Card
"card_id": "dd0b77cd-35ca-404e-8b23-1d86a7471f78",
"card_name": "card name",
"card_type": "Trivia",
"trivia_gameplay_id": "a4ae9ccc-712f-4a35-a7fe-938352786541",
"competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015",
// Prize
"prize_recipient_id": "39875c41-ab5b-44dd-9d2a-2818ba5acea3",
"prize_id": "3c5f45f3-5b63-4365-94a3-1b4889b179a5",
"prize_name": "First Prize",
}
NameTypeDescriptionOptional
idGuidA unique GUID identifier of the corresponding componentfalse
eventstringAn event name indicating the type of event that is being raisedfalse
timestampTimestampA timestamp indicating when the corresponding component was createdfalse
site_idGuidA GUID identifier which uniquely represents an active site.false
site_namestringThe name of the given site.false
user_session_idGuidA GUID identifier which uniquely represents an active user session.false
user_profile_idGuidA GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed intrue
User attributesstringIf 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
card_idGuidThe unique Id for the card.false
card_namestringThe name of the card indicated by the internal name listed on the card.false
card_typestringThe type of card that this event was triggered from.false
trivia_gameplay_idGuidThe unique id for the users gameplay on the trivia.false
competition_entry_idGuidThe unique GUID identifier of an entry of a competition for a given card.false
prize_recipient_idGuidA GUID identifier which uniquely identifies a prize recipient.false
prize_idGuidA GUID identifier which uniquely identifies the prize.false
prize_namestringThe name of the prize.false

Trivia action bar clickedBeta

Raised when a user clicks on the action bar button in a trivia.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "TriviaGameplayActionBarClicked",
"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
// Card
"card_id": "dd0b77cd-35ca-404e-8b23-1d86a7471f78",
"card_name": "card name",
"card_type": "Trivia",
"trivia_gameplay_id": "a4ae9ccc-712f-4a35-a7fe-938352786541",
"competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015",
"action_bar_link": "https://google.com",
}
NameTypeDescriptionOptional
idGuidA unique GUID identifier of the corresponding componentfalse
eventstringAn event name indicating the type of event that is being raisedfalse
timestampTimestampA timestamp indicating when the corresponding component was createdfalse
site_idGuidA GUID identifier which uniquely represents an active site.false
site_namestringThe name of the given site.false
user_session_idGuidA GUID identifier which uniquely represents an active user session.false
user_profile_idGuidA GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed intrue
User attributesstringIf 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
card_idGuidThe unique Id for the card.false
card_namestringThe name of the card indicated by the internal name listed on the card.false
card_typestringThe type of card that this event was triggered from.false
trivia_gameplay_idGuidThe unique id for the users gameplay on the trivia.false
competition_entry_idGuidThe unique GUID identifier of an entry of a competition for a given card.false
action_bar_linkstringThe url that the action bar links out to.true

Live trivia social clickedComing soon

Raised when a user clicks to view one of your socials from a live trivia game.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "TriviaGameplaySocialClicked",
"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
// Card
"card_id": "dd0b77cd-35ca-404e-8b23-1d86a7471f78",
"card_name": "card name",
"card_type": "Trivia",
"trivia_gameplay_id": "a4ae9ccc-712f-4a35-a7fe-938352786541",
"competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015",
// Share
"social_platform": "facebook",
}
NameTypeDescriptionOptional
idGuidA unique GUID identifier of the corresponding componentfalse
eventstringAn event name indicating the type of event that is being raisedfalse
timestampTimestampA timestamp indicating when the corresponding component was createdfalse
site_idGuidA GUID identifier which uniquely represents an active site.false
site_namestringThe name of the given site.false
user_session_idGuidA GUID identifier which uniquely represents an active user session.false
user_profile_idGuidA GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed intrue
User attributesstringIf 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
card_idGuidThe unique Id for the card.false
card_namestringThe name of the card indicated by the internal name listed on the card.false
card_typestringThe type of card that this event was triggered from.false
trivia_gameplay_idGuidThe unique id for the users gameplay on the trivia.false
competition_entry_idGuidThe unique GUID identifier of an entry of a competition for a given card.false
social_platformstringThe name of the social platform that will be used to share content to.false