Events
Cards
Live predictor

Live predictor events

Events from our Live predictor card

Live predictor startedComing soon

Raised when a user starts a live predictor card.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "PredictiveStarted",
"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": "Predictive",
"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
competition_entry_idGuidThe unique GUID identifier of an entry of a competition for a given card.false

Live predictor answeredBeta

Raised when a user answers a question in a live predictor card.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "PredictiveAnswered",
"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": "Predictive",
"competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015",
"segment_id": "e576d122-a731-4412-9e62-92d0b146c1a7",
"segment_name": "Third quarter",
// Answer
"question_id": "15ec92cb-b802-4623-a42d-8800aa63f962",
"question_text": "What is 2 + 2?",
"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
competition_entry_idGuidThe unique GUID identifier of an entry of a competition for a given card.false
segment_idGuidThe unique GUID representation used to identify the segment.false
segment_namestringThe name of the segment.false
question_idGuidThe Id for the question answered.false
question_textstringThe question text.false
question_answerstringThe text that is displayed on the selected answer or the slider value that is submitted.true