Skip to main content
WEBHOOK

Headers

Signature
string
required

HMAC SHA256 signature of the request body. Generated using the webhook's signing key and the raw JSON payload.

Generate the same value in your endpoint and compare it with this header to validate the webhook payload.

Example:

"a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890"

Body

application/json

Payload delivered for user-related events. Combines the user resource with the common webhook envelope fields (event, timestamp, trigger, source).

Detailed user fields returned only for a single user.

analytics_cookies
boolean

Specifies whether the user accepted analytics cookies.

broadcast_emails
boolean

Specifies whether the user accepted broadcast emails.

comments
string

Administrative notes recorded against the user, formatted for export.

confirmation
string

Account confirmation status of the user, such as Confirmed or Invited.

confirmed_at
string<date-time> | null

Date and time when the user confirmed the account. Value is null for an invited user who has not yet confirmed.

created_at
string<date-time>

Date and time when the user account was created.

created_by
string

Method by which the user account was created, such as manual or registration.

email
string<email> | null

Email address of the user. Value is null when no email address is recorded.

first_name
string

First name of the user.

language
object

Preferred language of the user.

last_name
string

Last name of the user.

marketing_cookies
boolean

Specifies whether the user accepted marketing cookies.

mobile
string

Mobile phone number of the user.

name
string

Full name of the user.

necessary_cookies
boolean

Specifies whether the user accepted necessary cookies.

notification_emails
boolean

Specifies whether the user accepted notification emails.

notification_sms
boolean

Specifies whether the user accepted notification text messages.

roles
object[]

Roles assigned to the user within the account.

slug
string

URL-safe identifier of the user.

updated
string<date-time>

Date and time when the user account was last updated.

preferences
object

Notification preferences selected by the user.

social_sharing
boolean

Specifies whether the user opted in to social sharing.

user_fields
object[]

Custom field responses captured on the user profile.

event
string

Human-readable name of the event that triggered the webhook.

Example:

"User created"

timestamp
string<date-time>

ISO 8601 formatted datetime indicating when the event occurred.

Example:

"2020-01-01T00:00:00Z"

trigger
string

Machine-readable event key that fired the webhook. Full list of events can be found here.

Example:

"user_created"

source
enum<string>
default:ui

Origin of the change that triggered the event.

Available options:
ui,
api

Response

200

Return any 2xx status code to acknowledge receipt of the event.