Video card events

Events from our Video cards, i.e. YouTube, Facebook Watch, Twitch

Video viewedBeta

Raised when a user watches a video on a video card.

Example data

{
  "id": "54e635de-92f5-4419-a498-5f69323db34c",
  "event": "VideoViewed",
  "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": "Youtube",
  "video_url": "https://www.youtube.com/watch?v=lXMskKTw3Bc",
}

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
video_url	string	The URL of the video that will be played.	false

Video playedBeta

Raised when a user plays watching a video on a video card.

Example data

{
  "id": "54e635de-92f5-4419-a498-5f69323db34c",
  "event": "VideoPlayed",
  "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": "Youtube",
  "video_url": "https://www.youtube.com/watch?v=lXMskKTw3Bc",
}

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
video_url	string	The URL of the video that will be played.	false

Video finishedBeta

Raised when a user finished watching a video on a video card.

Example data

{
  "id": "54e635de-92f5-4419-a498-5f69323db34c",
  "event": "VideoFinished",
  "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": "Youtube",
  "video_url": "https://www.youtube.com/watch?v=lXMskKTw3Bc",
}

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
video_url	string	The URL of the video that will be played.	false

Quiz Watch to win