README

This package handles the incoming webhook calls by Buy me a Coffee. It emits Events with the provided data and you can implement the corresponding listener on your own.

Installation

You can install the package via composer:

composer require rokde/laravel-buymeacoffee-webhook-handler

You can publish the config file with:

php artisan vendor:publish --tag="laravel-buymeacoffee-webhook-handler-config"

This is the contents of the published config file:

return [
    'url' => env('BUY_ME_A_COFFEE_WEBHOOK_HANDLER_URL', '/webhooks/buymeacoffee'),
    'secret' => env('BUY_ME_A_COFFEE_WEBHOOK_SECRET'),
];

Usage

And configure the secret you are receiving from Buy me a coffee as environment variable BUY_ME_A_COFFEE_WEBHOOK_SECRET.

And you are ready to go.

You can configure your webhook url as environment variable too when you do not want to publish the configuration (BUY_ME_A_COFFEE_WEBHOOK_HANDLER_URL).

Configure your listener for the webhook events accordingly in your Laravel application.

CAUTION:

Please make sure to except the CSRF protection from the configured webhook url. You can take a look into laravel's documentation for this.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

rokde / laravel-buymeacoffee-webhook-handler

Maintainers

Details