× Docs Platform Dashboard Extensions Wallets Sign in

Events

The platform has a collection of internal events that can be configured to trigger webhooks.

Webhooks should always be created with a secure secret key. The secret key can be used to identify valid requests to your server. The secret is sent in the Authorization header of the webhook request.

The platform expects a 200 OK HTTP response when webhooks are called. If a 200 response is not returned, the platform will retry the webhook up to 12 times with a gradually increasing delay between each retry.

Every webhook includes a body containing a JSON object.

{
    "id": 1,
    "event": "event.name",
    "company": "company_id",
    "data": {

    }
}

The attributes in the above object are described below:

Attribute Description
id The unique id of the request. This id is shared between retries of the same request.
event The event that triggered the webhook
company The company identifier
data an object contained different data depending on the event

Supported events

The platform currently support the following webhook events:

Event Description
user.create user created event
user.update user updated event
user.password.reset user password reset request event
user.email.verify user email verification event (Email key)
user.mobile.verify user mobile verification event (OTP key)
mfa.sms.verify multi-factor SMS otp event
address.create address created event
address.update address updated event
document.create document created event
document.update document updated event
bank_account.create bank account created event
bank_account.update bank account updated event
crypto_account.create crypto account created event
crypto_account.update crypto account updated event
transaction.create transaction created event
transaction.update transaction updated event
transaction.initiate transaction initiated (pending) event
transaction.execute transaction executed (complete/failed) event