← Spec Hub | Category: Developer APIs
Technical guide for receiving and processing automated API & Webhook Schema Directory event notifications. Follow these security guidelines to prevent unauthorized webhook calls.
Supported Events: resource.created resource.updated resource.deleted event.triggered
Security validation specs for API & Webhook Schema Directory endpoints:
Authorization: Bearer sec_live_eacf331f0ffc35d4
const crypto = require('crypto');
const expected = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
const isValid = crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature));
import hmac, hashlib
expected = hmac.new(secret.encode(), raw_body, hashlib.sha256).hexdigest()
is_valid = hmac.compare_digest(expected, incoming_sig)
{
"id": "evt_index.html_89407",
"event": "resource.created",
"created_at": 1789764050,
"data": {
"resource_id": "res_543",
"status": "active"
}
}
curl -X POST https://your-domain.com/webhook/index.html \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sec_live_eacf331f0ffc35d4" \
-d '{"id": "evt_index.html_89407", "event": "resource.created", "created_at": 1789764050, "data": {"resource_id": "res_543", "status": "active"}}'
| Status Code | Status Meaning | Integration Action |
|---|---|---|
200 OK | Success | Event payload validated and queued. |
400 Bad Request | Malformed Payload | Check payload structure and JSON formatting. |
401 Unauthorized | Signature Mismatch | Verify secret key and digest computation. |
500 Error | Server Error | Triggers provider automated retry backoff. |
Always process incoming events asynchronously using a message queue. Never perform long-running DB queries or external API calls synchronously within the HTTP response handler.
Store processed event IDs in an atomic storage like Redis with a set expiration. If an incoming ID exists, acknowledge with 200 OK immediately without re-triggering logic.
A 429 status indicates your endpoint is being rate limited. Implement dynamic throttling or increase consumer worker threads in your queue worker.
Your framework might be auto-parsing JSON. HMAC generation requires the exact raw byte buffer of the request body before JSON middleware alters keys or spacing.