Interface VerifyWebhookRequestMiddlewareParams

Parameters required to verify the webhook request using a dedicated verifyWebhookRequestMiddleware express middleware.

interface VerifyWebhookRequestMiddlewareParams {
    expirationInSeconds?: number;
    payloadJsonSchema?: Record<string, unknown>;
    webhookSecret?: string;
}

Properties

expirationInSeconds?: number

An optional number of seconds. If a webhook request is older than the specified value - an error will be thrown.

payloadJsonSchema?: Record<string, unknown>

An optional JSON schema to verify the integrity of a payload structure.

webhookSecret?: string

A webhook-specific secret used to verify the webhook API request.