Skip to main content
POST
Register a webhook

Body

application/json

Request to register a webhook.

url
string
required

HTTPS URL to receive webhook POST requests

events
string[]
required

Event types: 'price_shift', 'whale_alert', 'analysis_complete'

secret
string
default:""

HMAC-SHA256 secret for payload verification

Response

Successful Response

Registered webhook details.

webhook_id
string
required

Unique webhook identifier

url
string
required

Destination URL

events
string[]
required

Subscribed event types

created_at
string<date-time>
required

When registered

enabled
boolean
default:true

Whether active

failure_count
integer
default:0

Consecutive delivery failures