Skip to main content
PATCH
Update webhook configuration
Update your integrator’s webhook URL, secret, and event subscriptions for receiving real-time notifications.
Set disable_webhooks to true to stop all outbound callbacks entirely and poll for status instead — useful for poll-only integrations. Defaults to false.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
webhook_url
string

Default webhook callback URL

Example:

"https://example.com/kotani/webhooks"

webhook_secret
string

Shared secret used to sign webhook payloads

Example:

"whsec_1234567890abcdef"

webhook_events
enum<string>[]

Webhook events this integrator should receive

Available options:
transaction.status.updated,
transaction.deposit.status.updated,
transaction.withdrawal.status.updated,
transaction.onramp.status.updated,
transaction.offramp.status.updated,
payment.confirmed,
kyc.status.changed,
refund.lightning.invoice_needed,
refund.completed,
refund.failed,
settlement.approved,
settlement.rejected,
settlement.processed,
settlement.cancelled,
settlement.paused,
settlement.batch.approved,
settlement.batch.rejected,
settlement.batch.processed,
settlement.batch.partial,
settlement.batch.cancelled,
settlement.batch.consolidated,
system.event
Example:
disable_webhooks
boolean
default:false

Set true to disable all callbacks (poll-only mode)

Example:

false

Response

success
boolean
Example:

true

message
string
Example:

"Integrator webhook settings updated successfully."

data
object