General Events

Most webhook event details will be co-located with the feature they support but here are some general events we support outside of our core features.

See how to subscribe to webhook events here.

User Signed Up: UserSignedUp

The UserSignedUp webhook event fires whenever a user record is first inserted into our system. This happens just after a user completes SMS login.

{
  "event": "UserSignedUp",
  "userId": "7a986e7d-783c-4cdd-90f8-eac6c3967651", // Lucra user identifier
  "email": "[email protected]", // nullable
  "username": "jan.doe", // Lucra username
  "phoneNumber": "15555555555"
}

User Has Been KYC Verified: UserKYCVerified

The UserKYCVerified webhook event fires whenever a user is successfully verified in the KYC (Know Your User) flow within Lucra. This event will only fire the first time a user is verified. If they become unverified and later successfully reverify, you will not receive the second verification event.

{
  "event": "UserKYCVerified",
  "userId": "7a986e7d-783c-4cdd-90f8-eac6c3967651", // Lucra user identifier
}

User Deposits Funds: FundsDeposited

The FundsDeposited webhook event fires whenever a user has deposited money into their Lucra account. This webhook fires for all available payment deposit methods.

{
  "event": "FundsDeposited",
  "userId": "7a986e7d-783c-4cdd-90f8-eac6c3967651", // Lucra user identifier
  "tenantId": "SAMPLE", // Your tenant identifier
  "properties": {
    "method": "CARD",
    "amount": 50,
    "fee": 1.5,
    "transactionStatus": "COMPLETED",
    "transactionId": "f56837c9-a1a2-450f-8668-2ccc5c4d625e", // Lucra transaction identifier
    "email": "[email protected]",
    "phone": "15551234567"
  }
}