Skip to Content
EventsCardsPicker

Picker events

Events from our Picker card

Picker started

Beta

Raised when a user first clicks on a picker card cover.

Example data

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

Picker finished

Beta

Raised when a user submits a completed picker creation.

Example data

{
  "id": "54e635de-92f5-4419-a498-5f69323db34c",
  "event": "PickerLayoutCompleted",
  "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": "Picker",
  // Picker creation
  "picker_creation_id": "f6a8e682-0b22-4f4f-bc43-e25546934e3b",
  "layout_id": "6310e817-94ec-4258-92e0-f198d21a5eb1",
  "layout_name": "Layout 2",
  "picker_selections": "[
      {
        slotName: 'Defender',
        slotId: 'd9615a40-d425-4f09-9802-2d377cf18e3e',
        itemText: 'Jason McMan',
        itemId: 'e00d9009-da77-468f-9598-66d1a6f6fa1a'
      }
    ]",
}
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
picker_creation_id
GUID
A GUID identifier unique to the user's creation.
False
layout_id
GUID
A GUID identifier for the formation used.
False
layout_name
String
The name of the formation used if it has been given one.
True
picker_selections
Array
An array of each item picked in the creation, each item in the array will have: slotName: (if one has been given) string, slotId: Guid, optionText: string, optionId: Guid.
False
CarouselCoupons