Webhooks

This page describes the webhook payloads associated with the lifecycle events.

User

Lifecycle

flowchart TD
  A[<a href="#user_A">Created</a>]
  B[<a href="#user_B">KYC pending</a>]
  C[<a href="#user_C">KYC approved</a>]
  D[<a href="#user_D">Active</a>]

  A --> B 
  B --> C
  C --> D

Payload

User created

{
  "event": {
    "orgId": 22959,
    "entity": "Users",
    "eventType": "CREATE",
    "numRetries": 0,
    "createdAt": "2025-11-11T09:07:20.468Z",
    "updatedAt": "2025-11-11T09:07:20.468Z"
  },
  "data": {
    "orgUserId": "lestrade.1762852159",
    "orgId": 22959,
    "kyc": false,
    "tnc": false,
    "userStatus": "PENDING",
    "userType": "INTERNAL"
  }
}

User KYC pending

{
  "event": {
    "orgId": 22959,
    "entity": "Users",
    "eventType": "KYC_PENDING",
    "numRetries": 0,
    "createdAt": "2025-11-11T09:07:20.898Z",
    "updatedAt": "2025-11-11T09:07:20.898Z"
  },
  "data": {
    "orgUserId": "lestrade.1762852159",
    "orgId": 22959,
    "kyc": true,
    "tnc": true,
    "userStatus": "ACTIVE",
    "userType": "INTERNAL"
  }
}

User KYC approved

{
  "event": {
    "orgId": 22959,
    "entity": "Users",
    "eventType": "KYC_PENDING",
    "numRetries": 0,
    "createdAt": "2025-11-11T09:07:20.898Z",
    "updatedAt": "2025-11-11T09:07:20.898Z"
  },
  "data": {
    "orgUserId": "lestrade.1762852159",
    "orgId": 22959,
    "kyc": true,
    "tnc": true,
    "userStatus": "ACTIVE",
    "userType": "INTERNAL"
  }
}

User active

{
  "event": {
    "orgId": 22959,
    "entity": "Users",
    "eventType": "UPDATE",
    "numRetries": 0,
    "createdAt": "2025-11-11T09:07:21.634Z",
    "updatedAt": "2025-11-11T09:07:21.634Z"
  },
  "data": {
    "orgUserId": "lestrade.1762852159",
    "orgId": 22959,
    "kyc": true,
    "tnc": true,
    "userStatus": "ACTIVE",
    "userType": "INTERNAL"
  }
}