Trivia events

Events from Live Trivia

Live trivia started
Beta

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",
}

Name	Type	Description	Optional
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
card_id	GUID	The unique Id for the card.	False
card_name	String	The name of the card indicated by the internal name listed on the card.	False
card_type	String	The type of card that this event was triggered from.	False
trivia_gameplay_id	GUID	The unique id for the users gameplay on the trivia.	False
competition_entry_id	GUID	The unique GUID identifier of an entry of a competition for a given card.	False

Live trivia question answered
Beta

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",
}

Name	Type	Description	Optional
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
card_id	GUID	The unique Id for the card.	False
card_name	String	The name of the card indicated by the internal name listed on the card.	False
card_type	String	The type of card that this event was triggered from.	False
trivia_gameplay_id	GUID	The unique id for the users gameplay on the trivia.	False
competition_entry_id	GUID	The unique GUID identifier of an entry of a competition for a given card.	False
question_id	GUID	The Id for the question answered.	False
question_text	String	The question text.	False
answer_option_id	GUID	The unique GUID representation for the submitted option.	False
question_answer	String	The text that is displayed on the answer selected.	True
answer_correct	Boolean	If the answer the user selected was correct or not.	False

Live trivia finished
Beta

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",
}

Name	Type	Description	Optional
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
card_id	GUID	The unique Id for the card.	False
card_name	String	The name of the card indicated by the internal name listed on the card.	False
card_type	String	The type of card that this event was triggered from.	False
trivia_gameplay_id	GUID	The unique id for the users gameplay on the trivia.	False
competition_entry_id	GUID	The unique GUID identifier of an entry of a competition for a given card.	False

Live trivia prize viewed
Coming 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",
}

Name	Type	Description	Optional
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
card_id	GUID	The unique Id for the card.	False
card_name	String	The name of the card indicated by the internal name listed on the card.	False
card_type	String	The type of card that this event was triggered from.	False
trivia_gameplay_id	GUID	The unique id for the users gameplay on the trivia.	False
competition_entry_id	GUID	The unique GUID identifier of an entry of a competition for a given card.	False
prize_recipient_id	GUID	A GUID identifier which uniquely identifies a prize recipient.	False
prize_id	GUID	A GUID identifier which uniquely identifies the prize.	False
prize_name	String	The name of the prize.	False

Trivia action bar clicked
Beta

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",
}

Name	Type	Description	Optional
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
card_id	GUID	The unique Id for the card.	False
card_name	String	The name of the card indicated by the internal name listed on the card.	False
card_type	String	The type of card that this event was triggered from.	False
trivia_gameplay_id	GUID	The unique id for the users gameplay on the trivia.	False
competition_entry_id	GUID	The unique GUID identifier of an entry of a competition for a given card.	False
action_bar_link	String	The url that the action bar links out to.	True

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",
}

Name	Type	Description	Optional
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
card_id	GUID	The unique Id for the card.	False
card_name	String	The name of the card indicated by the internal name listed on the card.	False
card_type	String	The type of card that this event was triggered from.	False
trivia_gameplay_id	GUID	The unique id for the users gameplay on the trivia.	False
competition_entry_id	GUID	The unique GUID identifier of an entry of a competition for a given card.	False
social_platform	String	The name of the social platform that will be used to share content to.	False

Trivia events

Live trivia startedBeta

Example data

Live trivia question answeredBeta

Example data

Live trivia finishedBeta

Example data

Live trivia prize viewedComing soon

Example data

Trivia action bar clickedBeta

Example data

Live trivia social clickedComing soon

Example data

Live trivia started
Beta

Live trivia question answered
Beta

Live trivia finished
Beta

Live trivia prize viewed
Coming soon

Trivia action bar clicked
Beta

Live trivia social clicked
Coming soon