Skip to main content
POST
/
api
/
external
/
webhook
Register webhook URLs
curl --request POST \
  --url https://api-prod.blaaiz.com/api/external/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payout_url": "https://yourapp.com/webhooks/payout",
  "collection_url": "https://yourapp.com/webhooks/collection"
}
'
{
  "message": "Webhook record created successfully",
  "data": {
    "signing_secret": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0"
  }
}

Authorizations

Authorization
string
header
required

Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.

Body

application/json
payout_url
string<uri>
required

URL to receive payout event notifications

collection_url
string<uri>
required

URL to receive collection, virtual account, and customer KYC event notifications. This includes customer.created, customer.verified, and customer.rejected.

Response

Webhook URLs registered successfully

message
string
required
data
object
required