Skip to main content
PATCH
cURL
Change a webhook’s destination URL, subscribed events, or active flag without recreating it. Promote a staging URL to production, or pause delivery during maintenance without losing the registration.
The signing secret is not affected by PATCH. To change it, use Rotate Webhook Secret. Use Idempotency-Key when retrying the same update body. A matching retry replays the original response; a different body with the same key returns 422.

Authorizations

Authorization
string
header
required

API key authentication. Send your key in the Authorization header as Bearer oxi_sk_live_.... Live keys require an active Pro subscription and return live data.

Headers

Idempotency-Key
string

Optional safe-retry key. Reuse the same value only when retrying the exact same mutation request body; a different body returns 422 and an in-flight matching request returns 409.

Required string length: 1 - 255

Path Parameters

id
integer<int64>
required

Webhook endpoint id owned by the authenticated API key user.

Body

application/json
name
string
Maximum string length: 100
url
string<uri>
event_types
enum<string>[]
Minimum array length: 1
Available options:
whale_trades_inserted,
live_sports_updated,
whale_trader_synced,
large_positions_updated,
wallet_grade_changed,
insider_radar_flag_raised,
smart_money_flow_detected
enabled
boolean

Response

Webhook destination

object
string
required
Allowed value: "webhook"
data
object
required
meta
object
required