EventType

  • Event identifier returned in an Event object. webhook_endpoint.test is reserved for test deliveries and cannot be used in a Webhook Endpoint's enabled_events.

    • Type: string · WebhookEventTypeenum

      Exact event identifier that a Webhook Endpoint can subscribe to. Wildcards such as * are not accepted.

      values
      • checkout_session.completed

        Sent when a Checkout Session has been completed.

      • payment.succeeded

        Sent when a payment has succeeded.

      • payment.failed

        Sent when a payment has failed.

      • payment_intent.authorized

        Sent when a Payment Intent has been authorized.

      • payment_intent.captured

        Sent when a Payment Intent has been captured.