Events
Cards
Quiz

Quiz / Poll / Personality Test card events

Events from our Quiz card types i.e. Quiz, Poll, Personality

Quiz startedBeta

Raised when a user starts a Quiz / Poll / Personality Test game.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "QuizStarted",
"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": "Quiz",
"score": "1",
"correct": "1",
}
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
scorenumberThe total number of points for the gameplay.false
correctnumberThe total number questions that the gameplay got correct.false

Quiz answeredBeta

Raised when a user answers a question on a quiz card.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "QuizAnswered",
"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": "Quiz",
"score": "1",
"correct": "1",
// 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",
}
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
scorenumberThe total number of points for the gameplay.false
correctnumberThe total number questions that the gameplay got correct.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

Quiz finishedBeta

Raised when a user finishes a quiz card.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "QuizFinished",
"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": "Quiz",
"score": "1",
"correct": "1",
}
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
scorenumberThe total number of points for the gameplay.false
correctnumberThe total number questions that the gameplay got correct.false