v1
latestSwagger 2.02026-07-1745100168.1 KBCreate hook
Request body
BatchFlushIntervalSec is the maximum time a batch may sit before being flushed even when below BatchMaxItems. 0 = use HooksConfig default, then DefaultHookBatchFlushIntervalSec.
BatchMaxItems caps the number of events bundled into one HTTP POST body. 0 = use HooksConfig.BatchMaxItems, then DefaultHookBatchMaxItems. Ignored for File hooks (they always write one event per line).
BatchMaxQueueItems caps the per-hook in-memory queue (pending + re-queued failures). When exceeded, the OLDEST events are dropped with a warning log so the queue never grows unbounded against an unreachable target. 0 = use HooksConfig default, then DefaultHookBatchMaxQueueItems.
EventTypes filters which events trigger delivery. Empty = all events.
MaxRetries is the number of delivery attempts before giving up. 0 means use the server default (3). For HTTP hooks this caps retries inside a single batch flush; events that still fail are re-queued for the next flush regardless of MaxRetries.
Metadata holds user-defined key-value pairs merged into every event payload delivered by this hook. Useful for tagging events with custom context (e.g. environment, tenant ID, region) without modifying the server config.
HMAC-SHA256 signing secret (HTTP only)
HTTP(S) URL or absolute file path
TimeoutSec is the per-attempt delivery timeout in seconds. 0 means use the server default (10s).
Response
Created