Events
Cards
Carousel

Vote/Carousel events

Events from our Vote/Carousel cards

Carousel item viewedComing soon

Raised when a user views an item of a carousel.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "CarouselItemViewed",
"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": "Carousel",
"item_index": "2",
"item_id": "818a091c-3271-45b0-a1dd-fbbdc7bac3bf",
}
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
item_indexnumberThe index of the item viewed starting from 0false
item_idstringThe unique id of the item viewedfalse

Carousel votedComing soon

Raised when a user votes on the carousel.

Example data

{
"id": "54e635de-92f5-4419-a498-5f69323db34c",
"event": "CanvasVoted",
"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": "Vote",
"item_id": "818a091c-3271-45b0-a1dd-fbbdc7bac3bf",
}
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
item_idstringThe unique id of the item viewedfalse