Skip to Content
EventsCardsWatch to win

Watch to win events

Events from our Watch to win card

Watch to Win started

Beta

Raised when a user starts a watch to win card.

Example data

{
  "id": "54e635de-92f5-4419-a498-5f69323db34c",
  "event": "InstantWinStarted",
  "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": "WatchToWin",
}
NameTypeDescriptionOptional
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

Watch to Win finished

Beta

Raised when a user finishes a watch to win card.

Example data

{
  "id": "54e635de-92f5-4419-a498-5f69323db34c",
  "event": "InstantWinFinished",
  "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": "WatchToWin",
}
NameTypeDescriptionOptional
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
VideoChecklist