Site Events
Events that will send off of the site
Sign up success
Raised when a user successfully signs up to a hub.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "SignUpSuccess", "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 // Data capture fields "optin": "true",}| Name | Type | Description | Required |
|---|---|---|---|
| id | GUID | A unique GUID identifier of the corresponding component | Required |
| event | String | An event name indicating the type of event that is being raised | Required |
| timestamp | TimeStamp | A timestamp indicating when the corresponding component was created | Required |
| site_id | GUID | A GUID identifier which uniquely represents an active site. | Required |
| site_name | String | The name of the given site. | Required |
| user_session_id | GUID | A GUID identifier which uniquely represents an active user session. | Required |
| 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 | Optional |
| 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. | Optional |
| Data capture fields | String | The fields that were attached to the form submitted. These will be added individually on the webhook body with the field's unique id as the key and the users response as the value. | Required |
Site viewed
Raised when a user successfully signs up to a hub.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "SiteViewed", "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}| Name | Type | Description | Required |
|---|---|---|---|
| id | GUID | A unique GUID identifier of the corresponding component | Required |
| event | String | An event name indicating the type of event that is being raised | Required |
| timestamp | TimeStamp | A timestamp indicating when the corresponding component was created | Required |
| site_id | GUID | A GUID identifier which uniquely represents an active site. | Required |
| site_name | String | The name of the given site. | Required |
| user_session_id | GUID | A GUID identifier which uniquely represents an active user session. | Required |
| 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 | Optional |
| 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. | Optional |