WebhookConfig

Defined in: packages/webhook/src/types/webhook.types.ts:3

Properties

algorithm?

optional algorithm?: "sha256" | "sha1"

Defined in: packages/webhook/src/types/webhook.types.ts:23

backoffMultiplier?

optional backoffMultiplier?: number

Defined in: packages/webhook/src/types/webhook.types.ts:8

batchSize?

optional batchSize?: number

Defined in: packages/webhook/src/types/webhook.types.ts:39

How many events queued by emit() go out in one batch. The emit() call that fills a batch sends it, retries included, before it resolves, unless another batch is still being sent: then the full batch follows that one, or, if that one fails, goes with the timer, the next call, or flush(). Infinity leaves every event for flush() or the timer. Defaults to 10, which also replaces a value below 1. emitSync() does not use it.

batchTimeoutMs?

optional batchTimeoutMs?: number

Defined in: packages/webhook/src/types/webhook.types.ts:45

With autoStart, how long in milliseconds the first event queued by emit() waits before its batch is sent. Defaults to 5000. emitSync() does not use it.

enabledEvents

enabledEvents: WebhookEventType[]

Defined in: packages/webhook/src/types/webhook.types.ts:28

enableSecurity

enableSecurity: boolean

Defined in: packages/webhook/src/types/webhook.types.ts:20

Signs every delivery with HMAC. While on, a delivery is never sent unsigned: endpoints need a secret (or secretKey must be set), and a stored endpoint without one gets a failed delivery and no request.