PHPackages spatie/laravel-github-webhooks - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. spatie/laravel-github-webhooks ActiveLibrary spatie/laravel-github-webhooks ============================== Handle GitHub webhooks in a Laravel application 1.3.0(2mo ago)93139.5k↓10.3%102MITPHPPHP ^8.0CI passing Since Jul 24Pushed 2mo ago1 watchersCompare [ Source](https://github.com/spatie/laravel-github-webhooks)[ Packagist](https://packagist.org/packages/spatie/laravel-github-webhooks)[ Docs](https://github.com/spatie/laravel-github-webhooks)[ GitHub Sponsors](https://github.com/Spatie)[ RSS](/packages/spatie-laravel-github-webhooks/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (16)Versions (14)Used By (2) Handle GitHub webhooks in a Laravel application =============================================== [](#handle-github-webhooks-in-a-laravel-application) [![Latest Version on Packagist](https://camo.githubusercontent.com/b71b88649d9f354cf209ee7238c156bb6f05f3a1d1a031a6f1a44a9f270662fc/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7370617469652f6c61726176656c2d6769746875622d776562686f6f6b732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/laravel-github-webhooks)[![GitHub Workflow Status](https://camo.githubusercontent.com/3819866b6b391ec2342b620abdd0606907437197aaf8a7c78d676213d6cf6be2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f7370617469652f6c61726176656c2d6769746875622d776562686f6f6b732f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473)](https://camo.githubusercontent.com/3819866b6b391ec2342b620abdd0606907437197aaf8a7c78d676213d6cf6be2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f7370617469652f6c61726176656c2d6769746875622d776562686f6f6b732f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473)[![Check & fix styling](https://github.com/spatie/laravel-github-webhooks/workflows/Check%20&%20fix%20styling/badge.svg)](https://github.com/spatie/laravel-github-webhooks/workflows/Check%20&%20fix%20styling/badge.svg)[![Total Downloads](https://camo.githubusercontent.com/6074ea628092737e641ee7167fd878031c13a8776da6ee30a53413af0ddc91ac/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7370617469652f6c61726176656c2d6769746875622d776562686f6f6b732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/laravel-github-webhooks) GitHub can notify your application of events using webhooks. This package can help you handle those webhooks. Out of the box, it will verify the GitHub signature of all incoming requests. All valid calls will be logged to the database. The package allows you to easily define jobs or events that should be dispatched when specific webhooks hit your app. Here's an example of such a job. ``` namespace App\Jobs\GitHubWebhooks; use Illuminate\Bus\Queueable; use Illuminate\Queue\SerializesModels; use Illuminate\Queue\InteractsWithQueue; use Illuminate\Contracts\Queue\ShouldQueue; use Spatie\GitHubWebhooks\Models\GitHubWebhookCall; class HandleIssueOpenedWebhookJob implements ShouldQueue { use InteractsWithQueue, Queueable, SerializesModels; public GitHubWebhookCall $gitHubWebhookCall; public function __construct( public GitHubWebhookCall $webhookCall ) {} public function handle() { // React to the issue opened at GitHub event here // You can access the payload of the GitHub webhook call with `$this->webhookCall->payload()` } } ``` Before using this package we highly recommend reading [the entire documentation on webhooks over at GitHub](https://docs.github.com/en/developers/webhooks-and-events/webhooks/about-webhooks). Are you a visual learner? ------------------------- [](#are-you-a-visual-learner) In [this stream on YouTube](https://www.youtube.com/watch?v=BKJbd-VlV88), I show how to use package, go over the source code, and explain how the package is tested. Support us ---------- [](#support-us) [![](https://camo.githubusercontent.com/0f405fbde6215c1d33e91e88fcb0dfba45a92635ac700f7ed90f51e765a93c2d/68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f6c61726176656c2d6769746875622d776562686f6f6b732e6a70673f743d31)](https://spatie.be/github-ad-click/laravel-github-webhooks) We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us). We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards). Installation ------------ [](#installation) You can install the package via composer: ``` composer require spatie/laravel-github-webhooks ``` You must publish the config file with: ``` php artisan vendor:publish --provider="Spatie\GitHubWebhooks\GitHubWebhooksServiceProvider" --tag="github-webhooks-config" ``` This is the contents of the config file that will be published at `config/github-webhooks.php`: ``` use Spatie\GitHubWebhooks\Models\GitHubWebhookCall; use Spatie\GitHubWebhooks\Jobs\ProcessGitHubWebhookJob; use Spatie\WebhookClient\WebhookProfile\ProcessEverythingWebhookProfile; return [ /* * GitHub will sign each webhook using a secret. You can find the used secret at the * webhook configuration settings: https://docs.github.com/en/developers/webhooks-and-events/webhooks/about-webhooks. */ 'signing_secret' => env('GITHUB_WEBHOOK_SECRET'), /* * You can define the job that should be run when a certain webhook hits your application * here. * * You can find a list of GitHub webhook types here: * https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads. * * You can use "*" to let a job handle all sent webhook types */ 'jobs' => [ // 'ping' => \App\Jobs\GitHubWebhooks\HandlePingWebhook::class, // 'issues.opened' => \App\Jobs\GitHubWebhooks\HandleIssueOpenedWebhookJob::class, // '*' => \App\Jobs\GitHubWebhooks\HandleAllWebhooks::class ], /* * This model will be used to store all incoming webhooks. * It should be or extend `Spatie\GitHubWebhooks\Models\GitHubWebhookCall` */ 'model' => GitHubWebhookCall::class, /* * When running `php artisan model:prune` all stored GitHub webhook calls * that were successfully processed will be deleted. * * More info on pruning: https://laravel.com/docs/8.x/eloquent#pruning-models */ 'prune_webhook_calls_after_days' => 10, /* * The classname of the job to be used. The class should equal or extend * Spatie\GitHubWebhooks\ProcessGitHubWebhookJob. */ 'job' => ProcessGitHubWebhookJob::class, /** * This class determines if the webhook call should be stored and processed. */ 'profile' => ProcessEverythingWebhookProfile::class, /* * When disabled, the package will not verify if the signature is valid. * This can be handy in local environments. */ 'verify_signature' => env('GITHUB_SIGNATURE_VERIFY', true), ]; ``` In the `signing_secret` key of the config file you should add a valid webhook secret. You can find the secret used at [the webhook configuration settings on the GitHub dashboard](https://dashboard.github.com/account/webhooks). Next, you must publish the migration with: ``` php artisan vendor:publish --provider="Spatie\GitHubWebhooks\GitHubWebhooksServiceProvider" --tag="github-webhooks-migrations" ``` After the migration has been published, you can create the `github_webhook_calls` table by running the migrations: ``` php artisan migrate ``` Finally, take care of the routing: At the GitHub webhooks settings of a repo you must configure at what URL GitHub webhooks should be sent. In the routes file of your app you must pass that route to the `Route::githubWebhooks` route macro: ``` Route::githubWebhooks('webhook-route-configured-at-the-github-webhooks-settings'); ``` Make sure when configuring the webhook url that the webhooks are send as `application/json` and not as `application/x-www-form-urlencoded`. Behind the scenes this macro will register a `POST` route to a controller provided by this package. We recommend to put it in the `api.php` routes file, so no session is created when a webhook comes in, and no CSRF token is needed. Should you, for any reason, have to register the route in your `web.php` routes file, then you must add that route to the `except` array of the `VerifyCsrfToken` middleware: ``` protected $except = [ 'webhook-route-configured-at-the-github-webhooks-settings', ]; ``` Usage ----- [](#usage) GitHub will send out webhooks for several event types. You can find the [full list of events types](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads)in the GitHub documentation. GitHub 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 GitHub. Unless something goes terribly wrong, this package will always respond with a `200` to webhook requests. Sending a `200`will prevent GitHub from resending the same event over and over again. All webhook requests with a valid signature will be logged in the `github_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 `github_webhook_calls` table but a `Spatie\GitHubWebhooks\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. ### Handling webhook requests using jobs [](#handling-webhook-requests-using-jobs) 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: ``` namespace App\Jobs\GitHubWebhooks; use Illuminate\Bus\Queueable; use Illuminate\Queue\SerializesModels; use Illuminate\Queue\InteractsWithQueue; use Illuminate\Contracts\Queue\ShouldQueue; use Spatie\GitHubWebhooks\Models\GitHubWebhookCall; class HandleIssueOpenedWebhookJob implements ShouldQueue { use InteractsWithQueue, Queueable, SerializesModels; public GitHubWebhookCall $gitHubWebhookCall; public function __construct( public GitHubWebhookCall $webhookCall ) {} public function handle() { // do your work here // you can access the payload of the webhook call with `$this->webhookCall->payload` } } ``` We highly recommend that you make this job queueable, because this will minimize the response time of the webhook requests. This allows you to handle more GitHub webhook requests and avoid timeouts. After having created your job you must register it at the `jobs` array in the `github-webhooks.php` config file. The key should be the name of [the GitHub event type](https://docs.github.com/en/developers/webhooks-and-events/events/github-event-types). Optionally, you can let it follow with a dot and the value that is in the action key of the payload of a event. ``` // config/github-webhooks.php 'jobs' => [ 'issues.opened' => \App\Jobs\GitHubWebhooks\HandleIssueOpenedWebhookJob::class, // will be called when issues are opened 'issues' => \App\Jobs\GitHubWebhooks\HandleIssuesWebhookJob::class, // will be called when issues are opened, created, deleted, ... '*' => \App\Jobs\GitHubWebhooks\HandleAllWebhooksJob::class, // will be called when any event/action comes in ], ``` ### Working with a `GitHubWebhookCall` model [](#working-with-a-githubwebhookcall-model) The `Spatie\GitHubWebhooks\Models\GitHubWebhookCall` model contains some handy methods: - `headers()`: returns an instance of `Symfony\Component\HttpFoundation\HeaderBag` containing all headers used on the request - `eventActionName()`: returns the event name and action name of a webhooks, for example `issues.opened` - `payload($key = null)`: returns the payload of the webhook as an array. Optionally, you can pass a key in the payload which value you needed. For deeply nested values you can use dot notation (example: `$githubWebhookCall->payload('issue.user.login');`). ### Handling webhook requests using events [](#handling-webhook-requests-using-events) 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 `github-webhooks::` event. The payload of the events will be the instance of `GitHubWebhookCall` 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 = [ 'github-webhooks::issues.opened' => [ App\Listeners\IssueOpened::class, ], ]; ``` Here's an example of such a listener: ```