Update webhook URL

Update your registered webhook URLs. Your collection_url receives collection events, virtual account events, and customer KYC events. Your optional kyc_url receives Signa verification session events; omit the field to leave it unchanged, or send null to clear it. Required scope: webhook:write.

PUTapi-prod.blaaiz.com/api/external/webhook/{businessWebhook}

Authorization

oauth2ClientCredentials webhook:write

AuthorizationBearer <token>

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

In: header

Scope: webhook:write

Path Parameters

businessWebhook*string

Webhook ID or reference to update.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

collection_url?string

Collection webhook URL. This receives collection events, virtual account events, and customer KYC events.

Formaturi

payout_url?string

Payout webhook URL

Formaturi

kyc_url?string

Optional. URL to receive Signa verification session events (merchant.kyc.session.completed and merchant.kyc.session.expired). Omit it if you do not use Signa. Send null to clear a URL you set before. If you omit the field entirely, the stored kyc_url is left unchanged.

Formaturi

Response Body

`application/json`

Update webhook URL

curl --request PUT \  --url 'https://example.com/api/external/webhook/string' \  --header 'Content-Type: application/json' \  --data '{  "collection_url": "https://yourapp.com/webhooks/collection",  "payout_url": "https://yourapp.com/webhooks/payout",  "kyc_url": "https://yourapp.com/webhooks/kyc"}'

{  "message": "Webhook record updated successfully"}