Using Stripe Webhooks

Available settings

dj-stripe provides the following settings to tune how your webhooks work:

• DJSTRIPE_WEBHOOK_URL
• DJSTRIPE_WEBHOOK_SECRET
• DJSTRIPE_WEBHOOK_VALIDATION
• DJSTRIPE_WEBHOOK_TOLERANCE
• DJSTRIPE_WEBHOOK_EVENT_CALLBACK

Using webhooks in dj-stripe

dj-stripe comes with native support for webhooks as event listeners.

Events allow you to do things like [sending an email to a customer when his payment has failed or trial period is ending.

This is how you use them:

    from djstripe import webhooks

    @webhooks.handler("customer.subscription.trial_will_end")
    def my_handler(event, **kwargs):
        print("We should probably notify the user at this point")

You can handle all events related to customers like this:

    from djstripe import webhooks

    @webhooks.handler("customer")
    def my_handler(event, **kwargs):
        print("We should probably notify the user at this point")

You can also handle different events in the same handler:

from djstripe import webhooks

@webhooks.handler("price", "product")
def my_handler(event, **kwargs):
    print("Triggered webhook " + event.type)

Webhook event creation and processing is now wrapped in a transaction.atomic() block to better handle webhook errors. This will prevent any additional database modifications you may perform in your custom handler from being committed should something in the webhook processing chain fail. You can also take advantage of Django's transaction.on_commit() function to only perform an action if the transaction successfully commits (meaning the Event processing worked):

from django.db import transaction
from djstripe import webhooks

def do_something():
    pass  # send a mail, invalidate a cache, fire off a Celery task, etc.

@webhooks.handler("price", "product")
def my_handler(event, **kwargs):
    transaction.on_commit(do_something)

Official documentation

Stripe docs for types of Events: https://stripe.com/docs/api/events/types

Stripe docs for Webhooks: https://stripe.com/docs/webhooks

Django docs for transactions: https://docs.djangoproject.com/en/dev/topics/db/transactions/#performing-actions-after-commit