Beignet API reference
    Preparing search index...

    Interface CreateHmacWebhookVerifierOptions

    Options for the generic HMAC webhook verifier.

    interface CreateHmacWebhookVerifierOptions {
        algorithm?: "SHA-256" | "SHA-384" | "SHA-512";
        eventIdPath?: string;
        eventTypePath?: string;
        provider?: string;
        secret: string;
        signatureHeader?: string;
        signaturePrefix?: string;
        timestamp?: HmacWebhookTimestampOptions;
    }
    Index
    algorithm? eventIdPath? eventTypePath? provider? secret signatureHeader? signaturePrefix? timestamp?
    algorithm?: "SHA-256" | "SHA-384" | "SHA-512"

    Web Crypto HMAC hash algorithm.

    "SHA-256"
    eventIdPath?: string

    Dot path used to read the event ID from a JSON payload.

    "id"
    eventTypePath?: string

    Dot path used to read the event type from a JSON payload.

    "type"
    provider?: string

    Provider name attached to verified events.

    secret: string
    signatureHeader?: string

    Header that carries the provider signature.

    "x-webhook-signature"
    signaturePrefix?: string

    Optional signature prefix, such as "sha256=".

    timestamp?: HmacWebhookTimestampOptions

    Optional timestamp source used to reject replayed generic HMAC webhooks.

    Settings
    Member Visibility

    On This Page
    Properties