General card events
Events that happen on all cards
Card viewedBeta
Raised when a user views a card.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "CardViewed", "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": "Quiz", "score": "1", "correct": "1",}| 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 |
| score | number | The total number of points for the gameplay. | false |
| correct | number | The total number questions that the gameplay got correct. | false |
Card cover clickedBeta
Raised when a user clicks on a card's cover.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "CardCoverClicked", "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": "Quiz", "score": "1", "correct": "1",}| 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 |
| score | number | The total number of points for the gameplay. | false |
| correct | number | The total number questions that the gameplay got correct. | false |
Card actionBeta
Raised when a user clicks or interacts with a card's action.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "CardAction", "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": "Quiz", "score": "1", "correct": "1", "action": "Competition", "link_to": "https://www.komo.tech/",}| 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 |
| score | number | The total number of points for the gameplay. | false |
| correct | number | The total number questions that the gameplay got correct. | false |
| action | string | The action being performed. "Competition": an image card opening a competition, "ExternalLink": a link to an external site, "ScrollToCard": scroll to another card on the hub | false |
| link_to | string | The link or card Id that the card links to if any. | true |
Card sharedBeta
Raised when a user shares a card from a hub.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "CardShared", "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": "Quiz", "score": "1", "correct": "1", // Share "social_platform": "facebook",}| 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 |
| score | number | The total number of points for the gameplay. | false |
| correct | number | The total number questions that the gameplay got correct. | false |
| social_platform | string | The name of the social platform that will be used to share content to. | false |