hjmsw/sendgrid-event-api

dev-master 2018-08-04 21:22 UTC

This package is not auto-updated.

Last update: 2024-10-04 07:19:08 UTC


README

Description

A Laravel package that consumes SendGrid webhook events and makes them available via an API interface.

Access via REST API (disabled by default) or access package classes directly.

Installation

To get the latest version, simply require the project using Composer:

$ composer require hjmsw/sendgrid-event-api

Database migrations are included in database/migrations. To run them, execute:

$ php artisan migrate

REST API

REST API access is disabled by default. If you need access to this, first publish the package config file:

$ php artisan vendor:publish

Select the Provider: Hjmsw\SendGridEventApi\Providers\SendGridEventProvider option. You should now have a file named sendgrid_event_api.php in your app's config directory.

Change the value of enable_rest_access to true to enable.

You should now be able to access event data by making calls to (get) /events

License

This package is licensed under The MIT License (MIT).