bothy-sdk
    Preparing search index...

    Interface VerifyWebhookOptions

    The input of verifyWebhook.

    interface VerifyWebhookOptions {
        body: string | Uint8Array<ArrayBufferLike>;
        headers: WebhookHeaders;
        keys?: readonly (string | KeyObject)[];
        now?: () => number;
        secrets?: readonly (string | Uint8Array<ArrayBufferLike>)[];
        toleranceMs?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    body headers keys? now? secrets? toleranceMs?

    Properties

    Readonlybody

    body: string | Uint8Array<ArrayBufferLike>

    The raw request body exactly as received; a string counts as its UTF-8 bytes. Never pass a body that was parsed and serialized again.

    headers: WebhookHeaders

    The request headers, looked up case-insensitively.

    keys?: readonly (string | KeyObject)[]

    Trusted v1a public keys: parsed keys or their whpk_ form, normally the result of WebhookKeyCache.keys(). Never taken from the request.

    now?: () => number

    The own clock, Unix milliseconds; default Date.now.

    secrets?: readonly (string | Uint8Array<ArrayBufferLike>)[]

    Trusted v1 secrets: their whsec_ form or the raw key bytes.

    toleranceMs?: number

    Largest distance of webhook-timestamp to VerifyWebhookTrust.now in milliseconds; default webhook.receiver_tolerance.

    Settings

    Member Visibility

    On This Page

    Properties