basalt / webhooks/src / WebhookEndpoint

Interface: WebhookEndpoint

Defined in: webhooks/src/store.ts:3

Properties

active?

> optional active?: boolean

Defined in: webhooks/src/store.ts:23

Soft-disable without deleting. Default true.

---

events

> events: string[]

Defined in: webhooks/src/store.ts:7

Event patterns this endpoint receives: exact (invoice.paid), prefix (invoice.*) or *.

---

id

> id: string

Defined in: webhooks/src/store.ts:4

---

previousSecret?

> optional previousSecret?: string

Defined in: webhooks/src/store.ts:19

The secret secret replaced, set by WebhookManager.rotateSecret(). While previousSecretExpiresAt is in the future, deliveries are signed with BOTH (t=…,v1=<current>,v1=<previous>), so the receiver can switch secrets at its own pace. Ignored without an expiry, or once it has passed. The key present with the value undefined means "clear it" to a store's add().

---

previousSecretExpiresAt?

> optional previousSecretExpiresAt?: Date

Defined in: webhooks/src/store.ts:21

End of the rotation grace window for previousSecret.

---

secret?

> optional secret?: string

Defined in: webhooks/src/store.ts:11

Per-endpoint signing secret (overrides the deliverer default).

---

tenantId?

> optional tenantId?: string

Defined in: webhooks/src/store.ts:9

Restrict delivery to one tenant. Omit to receive from all tenants.

---

url

> url: string

Defined in: webhooks/src/store.ts:5