Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

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

Body

application/json
url
string<uri>
required
Example:

"https://ops.acme-treasury.com/webhooks/ground"

events
enum<string>[]
required

Event types to subscribe to.

Minimum array length: 1
Available options:
portfolio_wallet.status_changed,
portfolio_wallet.deposit.status_changed,
portfolio_wallet.withdrawal.status_changed,
portfolio_wallet.withdrawal.payout.status_changed,
portfolio_wallet.strategy.status_changed,
portfolio_wallet.rebalance.status_changed,
portfolio_wallet.risk.alert.triggered,
portfolio_wallet.risk.alert.resolved,
portfolio_wallet.risk.action.status_changed,
portfolio_wallet.risk.unwind.completed
description

Optional description. The current API stores truthy JSON values and ignores unknown request fields.

Example:

"Notify treasury operations when wallet balances or withdrawals change"

Response

Webhook created

A webhook registration. The signing secret is only returned in the creation response.

id
string<uuid>
required
url
string<uri>
required
events
string[]
required

Subscribed event types.

createdAt
string<date-time>
required
secret
string
required

Signing secret. Only returned on creation. Store securely.