basalt / webhooks/src / WebhookDispatchOptions

Interface: WebhookDispatchOptions

Explicit scope for WebhookManager.dispatch off the request path.

Properties

allTenants?

> optional allTenants?: boolean

Deliberate system fan-out: deliver to every matching endpoint of EVERY tenant. Ignored inside a tenant context. Without it, a tenant-less dispatch reaches only tenant-agnostic endpoints.

idempotencyKey?

> optional idempotencyKey?: string

Defined in: webhooks/src/index.ts:255

Idempotency key of this logical dispatch (e.g. an outbox entry id). When set, each endpoint's delivery id is derived from it and the endpoint id (deriveDeliveryId), so re-dispatching the same key re-sends the SAME id the receiver dedupes on. Default: a fresh id per delivery.

skipEndpointIds?

> optional skipEndpointIds?: Iterable<string, any, any>

Defined in: webhooks/src/index.ts:257

Endpoint ids to skip (e.g. already delivered for this idempotency key).

tenantId?

> optional tenantId?: string

Defined in: webhooks/src/index.ts:242

Deliver as this tenant (ignored when a tenant is in context — anti-widening).