Beignet API reference
    Preparing search index...

    Type Alias HmacWebhookTimestampOptions

    HmacWebhookTimestampOptions:
        | {
            format?: HmacWebhookTimestampFormat;
            header: string;
            payloadPath?: never;
            toleranceSec?: number;
        }
        | {
            format?: HmacWebhookTimestampFormat;
            header?: never;
            payloadPath: string;
            toleranceSec?: number;
        }

    Timestamp source and tolerance for generic HMAC replay protection.

    Type Declaration

    • {
          format?: HmacWebhookTimestampFormat;
          header: string;
          payloadPath?: never;
          toleranceSec?: number;
      }
      • Optionalformat?: HmacWebhookTimestampFormat

        Timestamp format.

        "unix-seconds"
        
      • header: string

        Header that carries the provider event timestamp. Header timestamps are authenticated as <timestamp>.<rawBody>.

      • OptionalpayloadPath?: never
      • OptionaltoleranceSec?: number

        Maximum absolute clock skew between the event timestamp and receipt.

        300
        
    • {
          format?: HmacWebhookTimestampFormat;
          header?: never;
          payloadPath: string;
          toleranceSec?: number;
      }
      • Optionalformat?: HmacWebhookTimestampFormat

        Timestamp format.

        "unix-seconds"
        
      • Optionalheader?: never
      • payloadPath: string

        Dot path used to read the provider event timestamp from the JSON payload.

      • OptionaltoleranceSec?: number

        Maximum absolute clock skew between the event timestamp and receipt.

        300