Create Webhook

Create a new webhook subscription.

Registers a URL to receive real-time HTTP POST notifications when events occur in your organization. Each webhook can optionally filter by resource type and event namespace. The response includes a signing_secret for verifying webhook payloads.

Use Cases

  • Set up real-time notifications for ingestion events (task completed, failed, etc.).
  • Subscribe an external system (Slack, CI/CD, data pipeline) to receive updates.
  • Monitor specific resource types or event namespaces.

How it works

  1. Create โ€” Register your endpoint URL and optional filters.
  2. Store secret โ€” Save the signing_secret from the response (only shown once).
  3. Verify โ€” Call POST /webhooks/{id}/verify to confirm your endpoint is reachable.
  4. Receive events โ€” Once verified, your endpoint receives signed HTTP POST requests for matching events.

Signing

All webhook payloads include an x-webhook-signature header. Verify it using HMAC-SHA256 with your signing secret to ensure authenticity.

Required scope: webhooks:write