Skip to main content
POST
/
v1
/
webhooks
Register a webhook
curl --request POST \
  --url https://api.example.com/v1/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "whale_alert",
    "analysis_complete"
  ],
  "secret": "whsec_abc123def456",
  "url": "https://my-agent.example.com/webhooks/rekko"
}
'
{
  "created_at": "2026-03-20T10:00:00Z",
  "enabled": true,
  "events": [
    "whale_alert",
    "analysis_complete"
  ],
  "failure_count": 0,
  "url": "https://my-agent.example.com/webhooks/rekko",
  "webhook_id": "wh-f47ac10b58cc"
}

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