brentnd/laravel-sparkposthooks

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

Laravel 5 / Lumen 5 SparkPost Webhook Controller

, _(*1)

A simple SparkPost 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 brentnd/laravel-sparkposthooks, _(*3)

Basic Usage

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

use Brentnd\Api\Webhooks\SparkPostWebhookController;

class MySparkPostController extends SparkPostWebhookController {

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

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

    /**
     * Handle an email open
     *
     * @param $payload
     */
    public function handleTrackEventOpen($payload)
    {
        $transmissionId = $payload['transmission_id'];
    }
}

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

post('sparkpost-webhook', ['as' => 'sparkpost.webhook', 'uses' => 'MySparkPostController@handleWebhook']);

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

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

Webhook Events

Webhook event types:, _(*8)

Common events and their handlers. For other events, just follow the same pattern., _(*9)

Contributors

Based on eventhomes/laravel-mandrillhooks, _(*10)