# Stripe Webhook Api

Please ensure you have added the webhook secret as per the [configuration](https://docs.umbcheckout.net/payment-providers/payment-providers/stripe/configuration).

{% hint style="info" %}
The minimum [Stripe API version](https://dashboard.stripe.com/developers) is `2024-11-20`

If you cannot use this version, please install a newer version of the [Stripe.net NuGet package](https://www.nuget.org/packages/Stripe.net), which matches the Stripe API versions available in your account.\
Use the [Stripe.net changelog](https://github.com/stripe/stripe-dotnet/blob/master/CHANGELOG.md) to find which version of the NuGet package you need.

**NOTE:** When upgrading between major versions of the Stripe.net NuGet package, there may be breaking changes, if you encounter these and have a paid license, open a [support ticket](https://docs.umbcheckout.net/support/support-tickets); otherwise, open an issue on [the tracker](https://github.com/UmbHost/UmbCheckout/issues)
{% endhint %}

You can configure Stripe to send the webhook request to the below api:

`/umbraco/api/StripeWebhookApi/CheckoutEvents`

This will trigger the following notifications

| Event                                | Notification                                                                                                                                                           |
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CheckoutSessionAsyncPaymentFailed    | [OnPaymentFailedNotification](https://docs.umbcheckout.net/payment-providers/payment-providers/stripe/notifications/onpaymentfailednotification)                       |
| CheckoutSessionAsyncPaymentSucceeded | [OnPaymentSuccessNotification](https://docs.umbcheckout.net/payment-providers/payment-providers/stripe/notifications/onpaymentsuccessnotification)                     |
| CheckoutSessionCompleted             | [OnCheckoutSessionCompletedNotification](https://docs.umbcheckout.net/payment-providers/payment-providers/stripe/notifications/oncheckoutsessioncompletednotification) |
| CheckoutSessionExpired               | [OnCheckoutSessionExpiredNotification](https://docs.umbcheckout.net/payment-providers/payment-providers/stripe/notifications/oncheckoutsessionexpirednotification)     |

{% hint style="info" %}
To be able to test the Webhook on localhost you need to install the [Stripe CLI](https://github.com/stripe/stripe-cli) you can find the instructions on how to configure the CLI to test the Webhook on the Stripe website using the link below, look for step 3 entitled "**Test the webhook**":

<https://stripe.com/docs/webhooks/quickstart?lang=dotnet#run>
{% endhint %}