Download the PHP package marshmallow/laravel-facebook-webhook without Composer
On this page you can find all versions of the php package marshmallow/laravel-facebook-webhook. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download marshmallow/laravel-facebook-webhook
More information about marshmallow/laravel-facebook-webhook
Files in marshmallow/laravel-facebook-webhook
Package laravel-facebook-webhook
Short Description A package to retrieve Facebook Leads with webhooks & Graph API in Laravel.
License MIT
Homepage https://github.com/marshmallow/laravel-facebook-webhook
Informations about the package laravel-facebook-webhook

Facebook Lead Webhook for Laravel
A package to retrieve Facebook Leads with webhooks & the Graph API in Laravel.
It builds on spatie/laravel-webhook-client to receive and process the incoming Facebook webhook, and on Laravel Socialite for the initial Facebook authentication. On an incoming webhook, the package retrieves the lead data through the Facebook Graph API and dispatches an event on completion.
Installation
Install the package via Composer:
This package uses spatie/laravel-webhook-client & Laravel Socialite. Please read the instructions from both packages!
Publish the migration from spatie/laravel-webhook-client to create the table that holds the webhook calls:
Make sure to add the correct config for the Spatie webhook package:
Please see the Socialite Base Installation Guide, then follow the provider-specific instructions below.
Add configuration to config/services.php
Publish the package config and migration
Publish the config file:
Publish and run the migration:
You may also publish both at once via the service provider:
Environment variables
Make sure the following .env variables are set up:
Configuration
The published config file lives at config/facebook-webhook.php. It supports multiple webhook endpoints through the configs array; each entry accepts the following keys:
| Key | Default | Description |
|---|---|---|
name |
facebook-lead |
Name of the webhook receiving endpoint. Use default if you only have one. |
process_facebook_webhook_job |
'' |
Class that processes the Facebook lead data. Should extend \Marshmallow\LaravelFacebookWebhook\Jobs\ProcessFacebookLeadJob. |
callback_route |
env('FACEBOOK_CALLBACK_ROUTE', 'webhook-client-facebook-lead') |
The callback route name for Facebook Leads. |
graph_api_version |
v14.0 |
The Graph API version used for Facebook requests. |
app_id |
env('FACEBOOK_CLIENT_ID') |
The App ID from the Facebook app. |
app_secret |
env('FACEBOOK_CLIENT_SECRET') |
The App Secret from the Facebook app. |
page_id |
env('FACEBOOK_PAGE_ID') |
The Page ID to retrieve the leads from. |
Setup
Create a Facebook app using the Facebook registration instructions. Make sure your app has the following permissions (a Page or User access token requested by a person who can advertise on the ad account and on the Page):
- The
ads_managementpermission - The
leads_retrievalpermission - The
pages_show_listpermission - The
pages_read_engagementpermission - The
pages_manage_adspermission
After setting up the migrations and the .env, run:
This command guides you through authenticating with Facebook, installing the app, and installing the webhook.
Usage
Specify which job should process the lead data via the process_facebook_webhook_job key in the config/facebook-webhook.php config file. Your job must extend Marshmallow\LaravelFacebookWebhook\Jobs\ProcessFacebookLeadJob, which exposes the retrieved lead data through the $webhookData property (a WebhookLeadResponse instance).
For example, create a job:
And register it in the config:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Marshmallow
- Spatie
- All Contributors
License
The MIT License (MIT). Please see the License File for more information.
All versions of laravel-facebook-webhook with dependencies
illuminate/contracts Version ^8.0|^9.0|^10.0|^11.0|^12.0|^13.0
laravel/socialite Version ^v5.5.1
socialiteproviders/facebook Version ^4.1.0
spatie/laravel-package-tools Version ^1.9.2
spatie/laravel-webhook-client Version ^3.1.0