Checklist events
Events from our Checklist card
Checklist startedBeta
Beta
Raised when a user starts a checklist card.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "ChecklistStarted", "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": "Checklist",}| 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 |
Checklist finishedBeta
Beta
Raised when a user finishes a checklist card.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "ChecklistFinished", "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": "Checklist", // Selected options "option_id_1": "2a806313-9222-4d8c-a55d-b3ce44265761", "option_text_1": "first option", "option_id_2": "605dcce8-9d97-479b-9c8e-b065cad61e81", "option_text_2": "second option",}| 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 |
| option_id_1 | GUID | The unique GUID representation of the first given checklist option. | False |
| option_text_1 | String | The text displayed on the first checklist option. | False |
| option_id_2 | GUID | The unique GUID representation of the second given checklist option. | False |
| option_text_2 | String | The text displayed on the second checklist option. | False |