Common Events
These events are common to all cards. For every event a specific card product can fire (including schemas), use Events by card type.
Card Viewed
- Event Name:
card-viewed - Triggered when a user views a card.
| Name | Type | Description | Required |
|---|---|---|---|
| timestamp | String (TimeStamp) | The timestamp of the event | Required |
| pageTitle | String | The title of the page where the event occurred | Required |
| hostName | String | The hostname of the page where the event occurred | Required |
| pathName | String | The path of the page where the event occurred | Required |
| queryString | String | The query string of the page where the event occurred | Required |
| url | String | The URL of the page where the event occurred | Required |
| referrer | String | The URL that linked to the page where the event occurred | Required |
| languages | Array | The languages of the browser that made the request | Required |
| userAgent | String | The user agent of the browser that made the request | Required |
| siteId | String (GUID) | The ID of the hub where the event occurred | Required |
| siteName | String | The name of the hub where the event occurred | Required |
| userId | String (GUID) | The ID of the user that performed the action | Required |
| contactId | String (GUID) | The ID of the contact that performed the action | Required |
| pageId | String (GUID) | The ID of the page where the event occurred | Optional |
| pageSlug | String | The slug of the page where the event occurred | Optional |
| cardId | String (GUID) | The ID of the card | Required |
| cardType | String | The type of the card | Required |
| cardSubType | String | The sub-type of the card | Required |
| cardName | String | The name of the card | Required |
Card Shared
- Event Name:
card-shared - Triggered when a user shares a card.
| Name | Type | Description | Required |
|---|---|---|---|
| timestamp | String (TimeStamp) | The timestamp of the event | Required |
| pageTitle | String | The title of the page where the event occurred | Required |
| hostName | String | The hostname of the page where the event occurred | Required |
| pathName | String | The path of the page where the event occurred | Required |
| queryString | String | The query string of the page where the event occurred | Required |
| url | String | The URL of the page where the event occurred | Required |
| referrer | String | The URL that linked to the page where the event occurred | Required |
| languages | Array | The languages of the browser that made the request | Required |
| userAgent | String | The user agent of the browser that made the request | Required |
| siteId | String (GUID) | The ID of the hub where the event occurred | Required |
| siteName | String | The name of the hub where the event occurred | Required |
| userId | String (GUID) | The ID of the user that performed the action | Required |
| contactId | String (GUID) | The ID of the contact that performed the action | Required |
| pageId | String (GUID) | The ID of the page where the event occurred | Optional |
| pageSlug | String | The slug of the page where the event occurred | Optional |
| cardId | String (GUID) | The ID of the card | Required |
| cardType | String | The type of the card | Required |
| cardSubType | String | The sub-type of the card | Required |
| cardName | String | The name of the card | Required |
| shareType | String (Link) | The type of share | Required |
| shareId | String | The ID of the share | Required |