These docs are for v1. Click to read the latest docs for v2.

User

Receive user object updates.

You should expect to receive webhook events whenever you successfully create or update a user.

Event Category:

  • USER

Event Type:

  • USER.STATUS: Creation or updates to the user object.

Event Action:

  • CREATE
  • UPDATE

Example webhook event

The data object is expected to have the same structure as the response from the Get User endpoint.

{
  "eventId": "evt_1934afd15d318dc8d5",
  "eventCategory": "USER",
  "eventType": "USER.STATUS",
  "eventAction": "CREATE",
  "createdAt": "2024-11-20T19:12:00.549Z",
  "timestamp": "2024-11-20T19:12:01.429Z",
  "data": {
  	"id": "1127a818-68cb-4ac0-a9ae-d17b5fe47b6f",
    "name": "John Doe",
    "type": "individual",
    "email": "[email protected]"
  }
}