Skip to main content
WEBHOOK
event-volume-spike
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event": "<string>",
  "data": {
    "event_slug": "<string>",
    "timeframe": "<string>",
    "current_volume_usd": 123,
    "snapshot_volume_usd": 123,
    "delta_volume_usd": 123,
    "spike_pct": 123,
    "txns": 123,
    "fees": 123,
    "event_title": "<string>",
    "image_url": "<string>"
  },
  "timestamp": 123,
  "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attempt": 2
}

Documentation Index

Fetch the complete documentation index at: https://docs.struct.to/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
X-Webhook-ID
string<uuid>
required

UUID of the webhook subscription that fired

​
X-Delivery-ID
string<uuid>
required

UUID of this specific delivery attempt (matches envelope id field)

​
X-Event-Type
string
required

Event name string (e.g. trader_first_trade)

​
X-Attempt
integer
required

Delivery attempt number (1 = first attempt)

Required range: x >= 1
​
X-Webhook-Signature
string

HMAC-SHA256 of the raw request body: sha256=<hex>. Present only when the webhook has a secret configured. Verify with: HMAC-SHA256(secret, raw_body_bytes) == hex_part.

Pattern: ^sha256=[0-9a-f]{64}$

Body

application/json

Webhook delivery envelope. The data field contains the event-specific payload.

Outer envelope for every webhook HTTP POST delivery. The data field contains the event-specific payload. Delivery headers sent with every POST: X-Webhook-ID (subscription UUID), X-Delivery-ID (this attempt's UUID), X-Event-Type (event name string, e.g. trader_first_trade), X-Attempt (attempt number, 1-indexed). When the webhook has a secret configured, X-Webhook-Signature: sha256=<hmac-hex> is also included — compute HMAC-SHA256 over the raw request body using your secret to verify.

​
id
string<uuid>
required

UUID of this specific delivery attempt (matches X-Delivery-ID header)

​
event
string
required

Event name (e.g. trader_first_trade). On test deliveries the suffix _test is appended.

​
data
object
required

Event volume spike webhook payload

​
timestamp
integer<int64>
required

Unix timestamp in milliseconds when this delivery was created

​
webhook_id
string<uuid>
required

UUID of the webhook subscription that fired (matches X-Webhook-ID header)

​
attempt
integer
required

Delivery attempt number. 1 = first attempt; increments on each retry.

Required range: x >= 1

Response

Webhook delivery acknowledged

Last modified on May 1, 2026