Create a Webhook

POST/api/v1/webhooks

Create a new webhook endpoint to receive real-time export notifications.

Request Body

ParameterTypeDescription

urlrequiredstringHTTPS URL for webhook delivery eventsrequiredarrayEvent types: export.created, export.finished, export.failed, export.requeued signingSecretrequiredstringSecret for HMAC-SHA256 signature verification enabledbooleanEnable the webhook (default: true)

bash

curl -X POST https://exportcomments.com/api/v1/webhooks \
  -H "X-AUTH-TOKEN: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/exportcomments",
    "events": ["export.finished", "export.failed"],
    "signingSecret": "whsec_your_secret_key_here"
  }'

Response201

json

{
  "uuid": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "url": "https://your-app.com/webhooks/exportcomments",
  "events": ["export.finished", "export.failed"],
  "status": 1,
  "enabled": true,
  "isSuspended": false,
  "lastEventAt": null,
  "webhookEventsCount": 0,
  "createdAt": "2026-02-23T12:00:00+00:00"
}