Skip to Content
EventsSite

Site events

Events that will send off of the site

Sign up success

Beta

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
  "email": "joe@bloggs.com",
  "first_name": "Joe",
  "last_name": "Bloggs",
  "optin": "true",
}
NameTypeDescriptionOptional
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
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.
False

Site viewed

Beta

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
}
NameTypeDescriptionOptional
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

Webhook success
Coming soon

Raised when a webhook sends successfully.

Example data

{
  "id": "54e635de-92f5-4419-a498-5f69323db34c",
  "event": "WebhookSuccess",
  "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
  // Web hook info
  "integration_id": "e772b5f1-47f4-4c43-ac01-8ef81990fa7d",
  "webhook_trigger": "SignUpSuccess",
}
NameTypeDescriptionOptional
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
integration_id
GUID
A GUID identifier which uniquely identifies the integration.
False
webhook_trigger
String
An event type which is used to identify the webhook trigger.
False

Webhook error
Coming soon

Raised when a webhook fails to send.

Example data

{
  "id": "54e635de-92f5-4419-a498-5f69323db34c",
  "event": "WebhookError",
  "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
  // Web hook info
  "integration_id": "e772b5f1-47f4-4c43-ac01-8ef81990fa7d",
  "webhook_trigger": "SignUpSuccess",
}
NameTypeDescriptionOptional
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
integration_id
GUID
A GUID identifier which uniquely identifies the integration.
False
webhook_trigger
String
An event type which is used to identify the webhook trigger.
False
FormsForms