Event object
eventId The unique id of the event that triggered the webhook message. A single event in a project can trigger one or more webhook messages if there is more than one webhook configured. messageId The unique id of the message sent. This key should be used as the idempotency key in order to handle redeliveries. webhookId The unique id of the configured webhook that sent the message. userId The unique id of the user who triggered the event. This can be different thanuserId’s in the event payload. For instance, when creating users via developer APIs the triggerer will be the developer’s userId and the event payload will contain the id of the created user. This parameter will be undefined if the event is triggered using an API key.
externalUserId
The external user id associated with the user who triggered the event. This field is only present when external authentication is enabled for the environment and the user has an associated external user id. Useful for correlating Dynamic webhook events with users in your own system.
eventName
The name of the event that triggered the message. Events always conform to the following convention {resourceType}.{action}. For example with the event name of user.created, user is the resource type and created is the action performed on the resource. The full list of event names can be retrieved by using the /eventTypes endpoint in the API here.
environmentId
The unique id of the environment from which the event originated.
environmentName
The name of the environment from which the event originated. This can be used to have the same systems handle both live and sandbox events.
timestamp
Timestamp when the event occurred.
redelivery
If the message is a redelivery, this will be set to true.
data
The data object contains the event payload. The structure of the data object will depend on the event that triggered the message. The product event catalogs below list each event’s payload.
Example Event Object
Below is an example of auser.created event
Event types
This is the list of all the types of events we send as part of webhook payloads. We may add more at any time, so when developing and maintaining your code, you should not assume that only these types exist. The current list of event types can be fetched from the event types endpoint. The events follow the pattern:resource.event. Our goal is to design a consistent system that makes it easy to anticipate and understand.
Events that occur on subresources like user.session will include the parent id
but do not trigger the parent’s update event.
Product event catalogs
Product-scoped event types are documented with their product:- Auth webhooks:
user.*lifecycle, sessions, sign-in, linked credentials, andvisit.created. - Embedded wallet webhooks:
wallet.*lifecycle, signatures, on-chain activity, key share, and recovery events. - Agent webhooks:
wallet.delegation.*events. - Business account action webhooks and proposal webhooks: all
businessAccount.*events. - Policy and screening webhooks:
waas.policy.violation, screening verdicts, andwallet.addressScreening.*. - Flow payments webhooks:
flow.*state-transition events.user.exchangeTransfer.*events are listed under Exchange accounts in Webhook events.
Admin
WAAS Policy
Occurs whenever a WAAS policy is created by an admin. Is a
WaasPolicyResponse.
Occurs whenever a WAAS policy is updated by an admin. Is a
WaasPolicyResponse.
Occurs whenever a WAAS policy rule is created by an admin. Is a
WaasPolicyRule.
Occurs whenever a WAAS policy rule is updated by an admin. Is a
WaasPolicyRule.
Occurs whenever a WAAS policy rule is deleted by an admin. Contains the deleted
rule information.
Domain
Occurs whenever a custom domain is created by an admin. Is a
CustomHostname.
Occurs whenever a custom domain is deleted by an admin. Contains the deleted
domain information.
Occurs whenever a custom domain is updated by an admin. Is a
CustomHostname.
Environment
Occurs whenever an API token is created by an admin. Is a
Token.
Occurs whenever environment settings are updated by an admin. Is a
ProjectEnvironment.
Occurs whenever an admin deletes a user’s MFA device. Contains the user ID and
MFA device information.
Organization
Occurs whenever an organization is created by an admin. Is an
Organization.
Occurs whenever an organization is updated by an admin. Is an
Organization.
Occurs whenever an organization’s billing settings are updated by an admin. Is a
BillingSubscription.
Occurs whenever a member is invited to an organization by an admin. Is an
Invite.
Occurs whenever a member joins an organization. Is an
OrganizationMember.
Occurs whenever a member is removed from an organization by an admin. Contains
the removed member information.
Project
Occurs whenever a project is created by an admin. Is a
Project.
Occurs whenever a project is updated by an admin. Is a
Project.
User
Occurs whenever a user is created by an admin. Is a
User.
Occurs whenever a user is updated by an admin. Is a
User.
Occurs whenever a user session is revoked by an admin. Is a
Session.
Webhook
Occurs whenever a webhook is created by an admin. Is a
Webhook.
Occurs whenever a webhook is updated by an admin. Is a
Webhook.
Security
Occurs whenever security access control settings are created by an admin. Is an
AdminSecurityAccessControl.
Occurs whenever a cookie domain is created by an admin. Is an
AdminSecurityCookieDomain.
Occurs whenever a CORS origin is created by an admin. Is an
OriginResponse.
Occurs whenever a CORS origin is deleted by an admin. Contains the deleted
CORS origin information.
Occurs whenever a CORS origin is updated by an admin. Is an
OriginResponse.
Occurs whenever IP settings are updated by an admin. Is an
AdminSecurityIpSettings.
Occurs whenever JWT settings are updated by an admin. Is an
AdminSecurityJwtSettings.
Address screening
Occurs whenever a screening
policy is created, meaning a sign-in or
transaction policy is authored for a provider that did not have one. The
payload contains
screeningPolicyId,
providerType, scope, revision, and addressEntryCount. userId is the
admin who made the change.Occurs whenever an existing screening policy is changed. Same payload as
admin.addressScreening.policy.created, plus change, which is rules,
addressAdded, or addressRemoved.Occurs whenever a screening policy is deleted. The screening that policy
covered returns to the sanctions baseline alone. Same payload as
admin.addressScreening.policy.created.These three events record that a policy changed, not what it now says. They do
not carry the rules. Read the policy back through the
ScreeningPolicies
endpoints, or compare revision.Environment
Occurs whenever an environment is updated, including updates made through
the SDK API rather than the Dynamic Console. Is a
ProjectEnvironment.