PHPackages                             rias/craft-stripe-webhooks - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. rias/craft-stripe-webhooks

ActiveCraft-plugin[Payment Processing](/categories/payments)

rias/craft-stripe-webhooks
==========================

Handle Stripe webhooks in a CraftCMS application

1.0.1(7y ago)72.0k4[1 issues](https://github.com/riasvdv/craft-stripe-webhooks/issues)[1 PRs](https://github.com/riasvdv/craft-stripe-webhooks/pulls)MITPHP

Since Jul 8Pushed 6y ago1 watchersCompare

[ Source](https://github.com/riasvdv/craft-stripe-webhooks)[ Packagist](https://packagist.org/packages/rias/craft-stripe-webhooks)[ RSS](/packages/rias-craft-stripe-webhooks/feed)WikiDiscussions master Synced today

READMEChangelog (3)Dependencies (2)Versions (4)Used By (0)

[![icon](./src/icon.svg)](./src/icon.svg)

[![Latest Version](https://camo.githubusercontent.com/a5ef95920a559a570292f0e590e27e767126728c9cbfef01d69194c4c5a2caf6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f726961737664762f63726166742d7374726970652d776562686f6f6b732e7376673f7374796c653d666c61742d737175617265)](https://github.com/riasvdv/craft-stripe-webhooks/releases)[![Quality Score](https://camo.githubusercontent.com/ac555873b22b6d35f84704d10494fce84a34db156e3d57c34f28650302d45487/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f726961737664762f63726166742d7374726970652d776562686f6f6b732e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/riasvdv/craft-stripe-webhooks)[![StyleCI](https://camo.githubusercontent.com/705f500fc3b83b66ef961d19ffa9cef42e08b24440448896b6fd5cf7318a09e5/68747470733a2f2f7374796c6563692e696f2f7265706f732f3134303135393537392f736869656c64)](https://styleci.io/repos/140159579)[![Total Downloads](https://camo.githubusercontent.com/47a1e4239ecc376590c47eaccf5d7b37962b217ba32ccb17835aff4c6e91efb0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f726961732f63726166742d7374726970652d776562686f6f6b732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/rias/craft-stripe-webhooks)

Handle Stripe webhooks in a CraftCMS application
================================================

[](#handle-stripe-webhooks-in-a-craftcms-application)

[Stripe](https://stripe.com) can notify your application of events using webhooks. This plugin can help you handle those webhooks. Out of the box it will verify the Stripe signature of all incoming requests. All valid calls will be logged to the database. You can easily define jobs or events that should be dispatched when specific events hit your app.

This plugin will not handle what should be done after the webhook request has been validated and the right job or event is called. You should still code up any work (eg. regarding payments) yourself.

Before using this plugin we highly recommend reading [the entire documentation on webhooks over at Stripe](https://stripe.com/docs/webhooks).

Support Open Source. Buy beer.
------------------------------

[](#support-open-source-buy-beer)

This plugin is licensed under a MIT license, which means that it's completely free open source software, and you can use it for whatever and however you wish. If you're using it and want to support the development, buy me a beer over at Beerpay!

[![Beerpay](https://camo.githubusercontent.com/78828f1b5d9a1add6328a778877293cb420152b52b52ba4ced88f5a66f081b4e/68747470733a2f2f626565727061792e696f2f726961737664762f63726166742d7374726970652d776562686f6f6b732f62616467652e7376673f7374796c653d626565722d737175617265)](https://beerpay.io/riasvdv/craft-stripe-webhooks)

Requirements
------------

[](#requirements)

This plugin requires Craft CMS 3.0.0.

Configuration
-------------

[](#configuration)

Create a `stripe-webhooks.php` config file with the following contents, or copy the one from the root of this plugin.

```
return [
    /*
     * Stripe will sign each webhook using a secret. You can find the used secret at the
     * webhook configuration settings: https://dashboard.stripe.com/account/webhooks.
     */
    'signingSecret' => '',

    /*
     * You can define the job that should be run when a certain webhook hits your application
     * here. The key is the name of the Stripe event type with the `.` replaced by a `_`.
     *
     * You can find a list of Stripe webhook types here:
     * https://stripe.com/docs/api#event_types.
     */
    'jobs' => [
        // 'source_chargeable' => \modules\sitemodule\jobs\StripeWebhooks\HandleChargeableSource::class,
        // 'charge_failed' => \modules\sitemodule\jobs\StripeWebhooks\HandleFailedCharge::class,
    ],

    /*
     * The classname of the model to be used. The class should equal or extend
     * rias\stripewebhooks\records\StripeWebhookCall.
     */
    'model' => \rias\stripewebhooks\records\StripeWebhookCall::class,

    /*
     * The url of the Stripe endpoint you want to use in your application
     */
    'endpoint' => 'stripe-webhooks',
];
```

In the `signingSecret` key of the config file you should add a valid webhook secret. You can find the secret used at [the webhook configuration settings on the Stripe dashboard](https://dashboard.stripe.com/account/webhooks).

Usage
-----

[](#usage)

Stripe will send out webhooks for several event types. You can find the [full list of events types](https://stripe.com/docs/api#event_types) in the Stripe documentation.

Stripe will sign all requests hitting the webhook url of your app. This package will automatically verify if the signature is valid. If it is not, the request was probably not sent by Stripe.

Unless something goes terribly wrong, this plugin will always respond with a `200` to webhook requests. Sending a `200` will prevent Stripe from resending the same event over and over again. All webhook requests with a valid signature will be logged in the `stripewebhooks_stripewebhookcall` table. The table has a `payload` column where the entire payload of the incoming webhook is saved.

If the signature is not valid, the request will not be logged in the `stripewebhooks_stripewebhookcall` table but a `rias\stripewebhooks\exceptions\WebhookFailed` exception will be thrown. If something goes wrong during the webhook request the thrown exception will be saved in the `exception` column. In that case the controller will send a `500` instead of `200`.

There are two ways this plugin enables you to handle webhook requests: you can opt to queue a job or listen to the events the package will fire.

### Handling webhook requests using jobs

[](#handling-webhook-requests-using-jobs)

If you want to do something when a specific event type comes in you can define a job that does the work. Here's an example of such a job:

```