Admin and environment events

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 than userId’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 a user.created event

{
  "eventId": "2a92c161-3167-44ad-8fce-4c6cdaed8129",
  "messageId": "5a2a5360-bb7e-4ea6-9bd3-0146bf2f734f",
  "webhookId": "a86acea4-e050-4846-8e4f-0ae039f6e37c",
  "userId": "a5914498-7a8b-4c58-b04c-9624fef2897c",
  "externalUserId": "usr_abc123",
  "eventName": "user.created",
  "environmentId": "123e4567-e89b-12d3-a456-426614174000",
  "environmentName": "sandbox",
  "timestamp": "2023-10-26T14:30:59.210Z",
  "data": {
    "chain": "EVM",
    "origin": null,
    "ipAddress": "::1",
    "verifiedCredentialId": "b13f337d-a8dc-41a7-96f5-5e5d76ad864a",
    "userId": "a5914498-7a8b-4c58-b04c-9624fef2897c",
    "expiresAt": null,
    "walletPublicKey": "0x3FcE1F4F28DbA209344072867134A3a7F547C7f1",
    "createdAt": "2023-10-26T14:30:02.909Z",
    "projectEnvironmentId": "7181a853-fb76-4dc2-9af8-6aeb6d2b818b",
    "provider": "browserExtension",
    "walletName": "metamask",
    "id": "484e49ba-3026-4e2c-9bf0-ed98ae224833",
    "revokedAt": "2023-10-26T14:30:59.204Z",
    "verifiedCredentialType": "wallet"
  }
}

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, and visit.created.
Embedded wallet webhooks: wallet.* lifecycle, signatures, on-chain activity, key share, and recovery events.
Agent webhooks: wallet.delegation.* events.
Business account webhooks: all businessAccount.* events.
Policy and screening webhooks: waas.policy.violation, screening verdicts, and wallet.addressScreening.*.
Flow webhooks: flow.* state-transition events, user.exchangeTransfer.*, and legacy checkout.transaction.* events.

Admin and environment events, which fire on developer-dashboard actions rather than end-user activity, are listed below.

Admin

WAAS Policy

object

Occurs whenever a WAAS policy is created by an admin. Is a WaasPolicyResponse.

object

Occurs whenever a WAAS policy is updated by an admin. Is a WaasPolicyResponse.

object

Occurs whenever a WAAS policy rule is created by an admin. Is a WaasPolicyRule.

object

Occurs whenever a WAAS policy rule is updated by an admin. Is a WaasPolicyRule.

object

Occurs whenever a WAAS policy rule is deleted by an admin. Contains the deleted rule information.

Domain

object

Occurs whenever a custom domain is created by an admin. Is a CustomHostname.

object

Occurs whenever a custom domain is deleted by an admin. Contains the deleted domain information.

object

Occurs whenever a custom domain is updated by an admin. Is a CustomHostname.

Environment

object

Occurs whenever an API token is created by an admin. Is a Token.

object

Occurs whenever an API token is deleted by an admin. Contains the deleted token information.

object

Occurs whenever environment settings are updated by an admin. Is a ProjectEnvironment.

object

Occurs whenever an admin deletes a user’s MFA device. Contains the user ID and MFA device information.

object

Occurs whenever all user sessions in an environment are revoked by an admin.

Organization

object

Occurs whenever an organization is created by an admin. Is an Organization.

object

Occurs whenever an organization is updated by an admin. Is an Organization.

object

Occurs whenever an organization’s billing settings are updated by an admin. Is a BillingSubscription.

object

Occurs whenever a member is invited to an organization by an admin. Is an Invite.

object

Occurs whenever a member joins an organization. Is an OrganizationMember.

object

Occurs whenever a member is removed from an organization by an admin. Contains the removed member information.

Project

object

Occurs whenever a project is created by an admin. Is a Project.

object

Occurs whenever a project is deleted by an admin. Contains the deleted project information.

object

Occurs whenever a project is updated by an admin. Is a Project.

User

object

Occurs whenever a user is created by an admin. Is a User.

object

Occurs whenever a user is deleted by an admin. Contains the deleted user information.

object

Occurs whenever a user is updated by an admin. Is a User.

object

Occurs whenever a user session is revoked by an admin. Is a Session.

Webhook

object

Occurs whenever a webhook is created by an admin. Is a Webhook.

object

Occurs whenever a webhook is deleted by an admin. Contains the deleted webhook information.

object

Occurs whenever a webhook is updated by an admin. Is a Webhook.

Security

object

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.

object

Occurs whenever a CORS origin is created by an admin. Is an OriginResponse.

object

Occurs whenever a CORS origin is deleted by an admin. Contains the deleted CORS origin information.

object

Occurs whenever a CORS origin is updated by an admin. Is an OriginResponse.

object

Occurs whenever IP settings are updated by an admin. Is an AdminSecurityIpSettings.

object

Occurs whenever JWT settings are updated by an admin. Is an AdminSecurityJwtSettings.

Address screening

object

Occurs whenever a bring-your-own-key address screening key is created by an admin.

object

Occurs whenever a bring-your-own-key address screening key is rotated by an admin.

object

Occurs whenever a bring-your-own-key address screening key is disabled by an admin.

object

Occurs whenever an address screening policy is created by an admin.

object

Occurs whenever an address screening policy is updated by an admin. Covers both a rules edit and an address-exception change; the payload’s change field says which.

object

Occurs whenever an address screening policy is deleted by an admin.

Environment

object

Occurs whenever an environment is updated, including updates made through the SDK API rather than the developer dashboard. Is a ProjectEnvironment.

Learn

Build with

Admin and environment events

Event object

Example Event Object

Event types

Product event catalogs

Admin

WAAS Policy

Domain

Environment

Organization

Project

User

Webhook

Security

Address screening

Environment

​Event object

​Example Event Object

​Event types

​Product event catalogs

​Admin

​WAAS Policy

​Domain

​Environment

​Organization

​Project

​User

​Webhook

​Security

​Address screening

​Environment

Event object

Example Event Object

Event types

Product event catalogs

Admin

WAAS Policy

Domain

Environment

Organization

Project

User

Webhook

Security

Address screening

Environment