Class Webhooks

constructor

• new Webhooks(): Webhooks

  Returns Webhooks

signature

constructEvent

• constructEvent(
      payload: string | Buffer<ArrayBufferLike>,
      header: string | string[] | Buffer<ArrayBufferLike>,
      secret: string,
      tolerance?: number,
      cryptoProvider?: CryptoProvider,
      receivedAt?: number,
  ): Stripe.Event

  Constructs and verifies the signature of an Event from the provided details.

  Parameters

  • payload: string | Buffer<ArrayBufferLike>

    Raw text body payload received from Stripe.

  • header: string | string[] | Buffer<ArrayBufferLike>

    Value of the stripe-signature header from Stripe. Typically a string.

    Note that this is typed to accept an array of strings so that it works seamlessly with express's types, but will throw if an array is passed in practice since express should never return this header as an array, only a string.

  • secret: string

    Your Webhook Signing Secret for this endpoint (e.g., 'whsec_...'). You can get this in your dashboard.

  • Optionaltolerance: number

    Seconds of tolerance on timestamps.

  • OptionalcryptoProvider: CryptoProvider

    Optional CryptoProvider to use for computing HMAC signatures.

  • OptionalreceivedAt: number

    Optional: timestamp to use when checking signature validity. Defaults to Date.now().

  Returns Stripe.Event

  Throws

  Stripe.errors.StripeSignatureVerificationError

constructEventAsync

• constructEventAsync(
      payload: string | Buffer<ArrayBufferLike>,
      header: string | string[] | Buffer<ArrayBufferLike>,
      secret: string,
      tolerance?: number,
      cryptoProvider?: CryptoProvider,
      receivedAt?: number,
  ): Promise<Stripe.Event>

  Asynchronously constructs and verifies the signature of an Event from the provided details.

  Parameters

  • payload: string | Buffer<ArrayBufferLike>

    Raw text body payload received from Stripe.

  • header: string | string[] | Buffer<ArrayBufferLike>

    Value of the stripe-signature header from Stripe. Typically a string.

    Note that this is typed to accept an array of strings so that it works seamlessly with express's types, but will throw if an array is passed in practice since express should never return this header as an array, only a string.

  • secret: string

    Your Webhook Signing Secret for this endpoint (e.g., 'whsec_...'). You can get this in your dashboard.

  • Optionaltolerance: number

    Seconds of tolerance on timestamps.

  • OptionalcryptoProvider: CryptoProvider

    Optional CryptoProvider to use for computing HMAC signatures.

  • OptionalreceivedAt: number

    Optional: timestamp to use when checking signature validity. Defaults to Date.now().

  Returns Promise<Stripe.Event>

  Throws

  Stripe.errors.StripeSignatureVerificationError

generateTestHeaderString

• generateTestHeaderString(opts: WebhookTestHeaderOptions): string

  Generates a header to be used for webhook mocking

  Parameters

  • opts: WebhookTestHeaderOptions

  Returns string

generateTestHeaderStringAsync

• generateTestHeaderStringAsync(opts: WebhookTestHeaderOptions): Promise<string>

  Generates a header to be used for webhook mocking

  Parameters

  • opts: WebhookTestHeaderOptions

  Returns Promise<string>