eventhomes/laravel-mandrillhooks

A simple Mandrill webhook controller to help with events. Compatible with Laravel 5+ and Lumen 5+.

Laravel Mandrill Webhook Controller

, _(*1)

A simple Mandrill webhook controller to help with email events. Useful for notifying users that you cannot reach them via email inside your application. Compatible with Laravel 5+ and Lumen 5+., _(*2)

Installation

composer require eventhomes/laravel-mandrillhooks, _(*3)

Basic Usage

1) Create a controller that extends MandrillWebhookController as follows. You can then handle any Mandrillapp webhook event., _(*4)

use EventHomes\Api\Webhooks\MandrillWebhookController;

class MyController extends MandrillWebhookController {

    /**
     * Handle a hard bounced email
     *
     * @param $payload
     */
    public function handleHardBounce($payload)
    {
        $email = $payload['msg']['email'];
    }

    /**
     * Handle a rejected email
     *
     * @param $payload
     */
    public function handleReject($payload)
    {
        $email = $payload['msg']['email'];
    }
}

2) Create the route to handle the webhook. In your routes.php file add the following., _(*5)

post('mandrill-webhook', ['as' => 'mandrill.webhook', 'uses' => 'MandrillController@handleWebHook']);

3) Exclude your route from CSRF protection so it will not fail., _(*6)

4) Make sure you add your webhook in Mandrill to point to your route. You can do this here: https://mandrillapp.com/settings/webhooks, _(*7)

(Optional) Webhook Authentication

If you would like to increase the security of the webhooks. Add the MandrillWebhookServiceProvider provider to the providers array in config/app.php, _(*8)

'providers' => [
  ...
  EventHomes\Api\Webhooks\MandrillWebhookServiceProvider::class,
],

Next, publish the configuration via, _(*9)

php artisan vendor:publish --provider="EventHomes\Api\Webhooks\MandrillWebhookServiceProvider"

Simply add your Mandrill webhook key in the config file and requests will be authenticated., _(*10)

Webhook Events

Webhook event types:, _(*11)

Contributors

Special thanks to @rafaelbeckel and @minioak!, _(*12)