Package Data | |
---|---|
Maintainer Username: | cyrill.kalita@gmail.com |
Maintainer Contact: | cyrill.kalita@gmail.com (Cyrill Kalita) |
Package Create Date: | 2019-12-27 |
Package Last Update: | 2024-08-03 |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-10-24 15:00:10 |
Package Statistics | |
---|---|
Total Downloads: | 118,885 |
Monthly Downloads: | 9,545 |
Daily Downloads: | 504 |
Total Stars: | 47 |
Total Watchers: | 5 |
Total Forks: | 8 |
Total Open Issues: | 1 |
Mailgun can notify your application of mail events using webhooks. This package can help you handle those webhooks. Out of the box it will verify the Mailgun 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 package 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. what should happen) yourself.
Before using this package we highly recommend reading the entire documentation on webhooks over at Mailgun.
This package is an adapted copy of absolutely amazing spatie/laravel-stripe-webhooks
If you are upgrading from previous version, please note that spatie/laravel-webhook-client has been upgraded to ^3.0 - which adds an extra field into the webhooks table. Read upgrading instructions for more details.
You can install the package via composer:
composer require binary-cats/laravel-mailgun-webhooks
The service provider will automatically register itself.
You must publish the config file with:
php artisan vendor:publish --provider="BinaryCats\MailgunWebhooks\MailgunWebhooksServiceProvider" --tag="config"
This is the contents of the config file that will be published at config/mailgun-webhooks.php
:
return [
/*
* Mailgun will sign each webhook using a secret. You can find the used secret at the
* webhook configuration settings: https://app.mailgun.com/app/account/security/api_keys.
*/
'signing_secret' => env('MAILGUN_WEBHOOK_SECRET'),
/*
* You can define the job that should be run when a certain webhook hits your application
* here. The key is the name of the Mailgun event type with the `.` replaced by a `_`.
*
* You can find a list of Mailgun webhook types here:
* https://documentation.mailgun.com/en/latest/api-webhooks.html#webhooks.
*
* The package will automatically convert the keys to lowercase, but you should
* be congnisant of the fact that array keys are case sensitive
*/
'jobs' => [
// 'delivered' => \BinaryCats\MailgunWebhooks\Jobs\HandleDelivered::class,
],
/*
* The classname of the model to be used. The class should equal or extend
* Spatie\WebhookClient\Models\WebhookCall
*/
'model' => \Spatie\WebhookClient\Models\WebhookCall::class,
/*
* The classname of the model to be used. The class should equal or extend
* BinaryCats\MailgunWebhooks\ProcessMailgunWebhookJob
*/
'process_webhook_job' => \BinaryCats\MailgunWebhooks\ProcessMailgunWebhookJob::class,
];
In the signing_secret
key of the config file you should add a valid webhook secret. You can find the secret used at HTTP webhook signing key.
You can skip migrating is you have already installed Spatie\WebhookClient
Next, you must publish the migration with:
php artisan vendor:publish --provider="Spatie\WebhookClient\WebhookClientServiceProvider" --tag="webhook-client-migrations"
After migration has been published you can create the webhook_calls
table by running the migrations:
php artisan migrate
Finally, take care of the routing: At the Mailgun dashboard you must configure at what url Mailgun webhooks should hit your app. In the routes file of your app you must pass that route to Route::mailgunWebhooks()
:
I like to group functionality by domain, so I would suggest webhooks/mailgun
(especially if you plan to have more webhooks), but it is up to you.
# routes\web.php
Route::mailgunWebhooks('webhooks/mailgun');
Behind the scenes this will register a POST
route to a controller provided by this package. Because Mailgun has no way of getting a csrf-token, you must add that route to the except
array of the VerifyCsrfToken
middleware:
protected $except = [
'webhooks/mailgun',
];
Mailgun will send out webhooks for several event types. You can find the full list of events types in Mailgun documentation.
Mailgun 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 Mailgun.
Unless something goes terribly wrong, this package will always respond with a 200
to webhook requests. Sending a 200
will prevent Mailgun from resending the same event over and over again. All webhook requests with a valid signature will be logged in the webhook_calls
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 webhook_calls
table but a BinaryCats\MailgunWebhooks\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 package enables you to handle webhook requests: you can opt to queue a job or listen to the events the package will fire.
Due to the apparent differences between MailGun sandbox and production environment event casing, the package will ALWAYS cast mailgun events to lowercase - so your configured keys must be lowercase, too
The package does not handle legacy webhooks, as they have a different schema. Let me know if this is something that is needed.
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:
<?php
namespace App\Jobs\MailgunWebhooks;
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Spatie\WebhookClient\Models\WebhookCall;
class HandleDelivered implements ShouldQueue
{
use InteractsWithQueue, Queueable, SerializesModels;
/** @var \Spatie\WebhookClient\Models\WebhookCall */
public $webhookCall;
public function __construct(WebhookCall $webhookCall)
{
$this->webhookCall = $webhookCall;
}
public function handle()
{
// do your work here
// you can access the payload of the webhook call with `$this->webhookCall->payload`
}
}
Spatie highly recommends that you make this job queueable, because this will minimize the response time of the webhook requests. This allows you to handle more Mailgun webhook requests and avoid timeouts.
Just keep in mind that mailgun places both signature
and event-data
into response body.
After having created your job you must register it at the jobs
array in the mailgun-webhooks.php
config file. The key should be the name of mailgun event type. The value should be the fully qualified classname.
// config/mailgun-webhooks.php
'jobs' => [
'delivered' => \App\Jobs\MailgunWebhooks\HandleDelievered::class,
],
Instead of queueing jobs to perform some work when a webhook request comes in, you can opt to listen to the events this package will fire. Whenever a valid request hits your app, the package will fire a mailgun-webhooks::<name-of-the-event>
event.
The payload of the events will be the instance of WebhookCall
that was created for the incoming request.
Let's take a look at how you can listen for such an event. In the EventServiceProvider
you can register listeners.
/**
* The event listener mappings for the application.
*
* @var array
*/
protected $listen = [
'mailgun-webhooks::delivered' => [
App\Listeners\DeliveredSource::class,
],
];
Here's an example of such a listener:
<?php
namespace App\Listeners;
use Illuminate\Contracts\Queue\ShouldQueue;
use Spatie\WebhookClient\Models\WebhookCall;
class DeliveredSource implements ShouldQueue
{
public function handle(WebhookCall $webhookCall)
{
// do your work here
// you can access the payload of the webhook call with `$webhookCall->payload`
}
}
Spatie highly recommends that you make the event listener queueable, as this will minimize the response time of the webhook requests. This allows you to handle more Mailgun webhook requests and avoid timeouts.
The above example is only one way to handle events in Laravel. To learn the other options, read the Laravel documentation on handling events.
All incoming webhook requests are written to the database. This is incredibly valuable when something goes wrong while handling a webhook call. You can easily retry processing the webhook call, after you've investigated and fixed the cause of failure, like this:
use Spatie\WebhookClient\Models\WebhookCall;
use BinaryCats\MailgunWebhooks\ProcessMailgunWebhookJob;
dispatch(new ProcessMailgunWebhookJob(WebhookCall::find($id)));
You can add some custom logic that should be executed before and/or after the scheduling of the queued job by using your own job class. You can do this by specifying your own job class in the process_webhook_job
key of the mailgun-webhooks
config file. The class should extend BinaryCats\MailgunWebhooks\ProcessMailgunWebhookJob
.
Here's an example:
use BinaryCats\MailgunWebhooks\ProcessMailgunWebhookJob;
class MyCustomMailgunWebhookJob extends ProcessMailgunWebhookJob
{
public function handle()
{
// do some custom stuff beforehand
parent::handle();
// do some custom stuff afterwards
}
}
When needed might want to the package to handle multiple endpoints and secrets. Here's how to configure that behaviour.
If you are using the Route::mailgunWebhooks
macro, you can append the configKey
as follows:
Route::mailgunWebhooks('webhooks/mailgun/{configKey}');
Alternatively, if you are manually defining the route, you can add configKey
like so:
Route::post('webhooks/mailgun/{configKey}', 'BinaryCats\MailgunWebhooks\MailgunWebhooksController');
If this route parameter is present verify middleware will look for the secret using a different config key, by appending the given the parameter value to the default config key. E.g. If Mailgun posts to webhooks/mailgun/my-named-secret
you'd add a new config named signing_secret_my-named-secret
.
Example config might look like:
// secret for when Mailgun posts to webhooks/mailgun/account
'signing_secret_account' => 'whsec_abc',
// secret for when Mailgun posts to webhooks/mailgun/my-named-secret
'signing_secret_my-named-secret' => 'whsec_123',
Mailgun allows you to send transactional or bulk email effortlessly with our SMTP relay and flexible HTTP API.
Please see CHANGELOG for more information about what has changed recently.
composer test
Please see CONTRIBUTING for details.
If you discover any security related issues, please email cyrill.kalita@gmail.com instead of using issue tracker.
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Big shout-out to Spatie for their work, which is a huge inspiration.
Binary Cats is a webdesign agency based in Illinois, US.
The MIT License (MIT). Please see License File for more information.