Interface CreateStripeWebhookVerifierOptions

Options for the Stripe webhook verifier.

interface CreateStripeWebhookVerifierOptions {
    client?: StripeWebhookClient;
    secret: string | (() => string | undefined);
    signatureHeader?: string;
    tolerance?: number;
}

Properties

Existing Stripe SDK client. When omitted, a minimal client is created for webhook verification only.

secret: string | (() => string | undefined)

Stripe endpoint signing secret. Dashboard, live-mode, and Stripe CLI endpoint secrets are different values.

signatureHeader?: string

Header that carries Stripe's signature.

"stripe-signature"

tolerance?: number

Optional Stripe webhook timestamp tolerance in seconds.