Event object
eventIdThe 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.
eventNameThe 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.
environmentIdThe 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.
timestampTimestamp 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 full list of event payloads can be found here.
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.
User
Occurs whenever a user started the passkey recovery process. Is a
wallet.
Occurs whenever a user completed the passkey recovery process. Is a
wallet.
Occurs whenever an exchange transfer is successfully initiated. Is an
ExchangeTransferResponse.
Occurs whenever an exchange transfer fails for any reason. Contains error details
about the failure.
Wallet
Occurs whenever a wallet is transferred between user accounts. Is a
wallet.