Skip to content

basalt / webhooks/src / WebhookRotateSecretOptions

Interface: WebhookRotateSecretOptions ​

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

Options for WebhookManager.rotateSecret.

Properties ​

graceSeconds? ​

> optional graceSeconds?: number

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

How long deliveries keep being signed with the previous secret too, in seconds. 0 cuts over immediately (the previous secret stops signing now). Default DEFAULT_SECRET_ROTATION_GRACE_SECONDS (24 h); at most MAX_SECRET_ROTATION_GRACE_SECONDS (30 days).


secret? ​

> optional secret?: string

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

The new secret (min 16 chars). Default: a freshly generated whsec_….


system? ​

> optional system?: boolean

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

Deliberate unscoped rotation with tenancy active and no tenant.


tenantId? ​

> optional tenantId?: string

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

Scope off the request path (ignored when a tenant is in context — anti-widening).

Released under the MIT License.