Skip to main content

Overview

Webhooks deliver real-time HTTP POST notifications to your endpoint when events occur in your Doris workspace. Configure webhooks in the console at Settings > Developer > Webhooks. Each tenant can have up to 10 webhook subscriptions. Any member can view configured webhooks and delivery history; creating, editing, deleting, and testing webhooks requires a Doris admin role.

Event Types

Subscribe to specific event types using glob patterns:

Payload Format

Every webhook delivery is an HTTP POST with a JSON body:

Property change events

Semantic events

Headers

Every delivery includes these headers:

Verifying Signatures

Each webhook has a signing secret (shown once at creation, starts with whsec_). To verify a delivery is authentic:
Signature verification is optional. If you’re using n8n, Power Automate, or Zapier, you can safely ignore the X-Doris-Signature header — the payload will be delivered as standard JSON regardless.

Retry Policy

If your endpoint returns a non-2xx status code or is unreachable: After 3 failed attempts, the delivery is marked as failed. You can see delivery history in the console.

Responding

Return any 2xx status code to acknowledge receipt. The response body is ignored. If your endpoint takes longer than 10 seconds to respond, the delivery is treated as failed and will be retried.

Testing

Use the Test button in the console to send a test.ping event to your endpoint. This verifies your URL is reachable and responding with a 2xx status.