Axinom Mosaic Libraries
    Preparing search index...

    Interface ValidateWebhookRequestParams

    Parameters required to verify the webhook request using a dedicated validateWebhookRequest helper function.

    interface ValidateWebhookRequestParams {
        expirationInSeconds?: number;
        payloadJsonSchema?: Record<string, unknown>;
        requestBody: string | Dict<unknown>;
        requestSignature: string;
        webhookSecret?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    expirationInSeconds? payloadJsonSchema? requestBody requestSignature webhookSecret?

    Properties

    expirationInSeconds?: number

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

    120
    payloadJsonSchema?: Record<string, unknown>

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

    requestBody: string | Dict<unknown>

    Either a JSON or stringified API request body. Ideally, should be a string taken as is from the request to preserve the original serialization.

    requestSignature: string

    A signature generated from the stringified body and passed along with it as an x-mosaic-signature header.

    webhookSecret?: string

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

    Settings

    Member Visibility

    On This Page

    Properties