Site Events
These legacy webhook events are sent when users interact with a site.
Sign up success
Raised when a user successfully signs up to a site.
Example data
{"id": "54e635de-92f5-4419-a498-5f69323db34c","event": "SignUpSuccess","timestamp": "2000-01-01T00:00:00.000Z",// null// "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","User attributes": "",// "Any user attributes captured for the session/account will be added as well""submission_id": "c0ff823d-c8bf-4858-90b4-d536fe55b902","optin": "true"}| Name | Type | Description | Required |
|---|---|---|---|
| site_id | UUID | A UUID identifier which uniquely represents an active site. | Required |
| site_name | String | The name of the given site. | Required |
| user_session_id | UUID | A UUID identifier which uniquely represents an active user session. | Required |
| user_profile_id | UUID | A UUID 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 |
| submission_id | UUID | A UUID identifier that uniquely identifies an instance of a data capture form submission. | Required |
| optin | String | Whether the user opted in. | Required |
Site viewed
Raised when a user views a site.
Example data
{"id": "54e635de-92f5-4419-a498-5f69323db34c","event": "SiteViewed","timestamp": "2000-01-01T00:00:00.000Z",// null// "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","User attributes": "",// "Any user attributes captured for the session/account will be added as well"}| Name | Type | Description | Required |
|---|---|---|---|
| site_id | UUID | A UUID identifier which uniquely represents an active site. | Required |
| site_name | String | The name of the given site. | Required |
| user_session_id | UUID | A UUID identifier which uniquely represents an active user session. | Required |
| user_profile_id | UUID | A UUID 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 |