Weave Code
Webhook Laravel Package
symfony/webhook
Symfony Webhook simplifies sending and consuming webhooks in Symfony apps. It provides tools to define webhook endpoints, validate and process incoming payloads, and dispatch outgoing webhooks with a consistent, reusable workflow.
Eases sending and consuming webhooks
Frequently asked questions about Webhook
- Can Symfony Webhook replace Laravel’s manual HMAC validation for GitHub/GitLab webhooks?
- Yes. Symfony Webhook provides built-in HMAC validation via `Webhook::validate()`, eliminating custom middleware logic. For GitHub/GitLab, pass the `X-Hub-Signature-256` header and your secret to validate payloads securely. This reduces boilerplate while maintaining security. Example: `$webhook = new Webhook($payload, $request->headers->get('X-Hub-Signature-256')); if (!$webhook->validate('your-secret')) { abort(401); }`
- How do I integrate Symfony Webhook with Laravel’s Queue system for async outbound webhooks?
- Use Laravel’s Queues to dispatch outbound webhooks asynchronously. Wrap `Webhook::send()` in a job (e.g., `SendWebhookJob`) and dispatch it via `dispatch(new SendWebhookJob($url, $payload))`. Symfony’s retry logic can be extended via job middleware. This ensures high-volume webhooks (e.g., Slack notifications) don’t block HTTP responses.
- What Laravel versions does Symfony Webhook support, and are there compatibility issues?
- Symfony Webhook targets PHP 8.1+ and works with Laravel 9/10. No major compatibility issues exist, but align Symfony’s `HttpFoundation` dependency (v6.x) with Laravel’s PSR-15 middleware stack. Test with `laravel/framework:^10.0` for best results. If using older Laravel, check Symfony’s [version matrix](https://symfony.com/doc/current/setup.html#requirements).
- Does Symfony Webhook support custom payload validation (e.g., JSON Schema) for incoming webhooks?
- Out of the box, Symfony Webhook validates signatures but not payload schemas. Extend it by adding a custom validator (e.g., `JsonSchema::validate($payload)`) in middleware or a service. For Laravel, bind a validator to the container and inject it into your webhook handler. Libraries like `justinrain/json-schema` can integrate here.
- How do I log webhook failures or retries in Laravel’s logging system?
- Leverage Laravel’s `Log` facade to capture webhook events. Wrap `Webhook::send()` in a try-catch block and log failures: `Log::error('Webhook failed', ['url' => $url, 'error' => $e->getMessage()])`. For retries, extend Symfony’s `RetryStrategy` and log each attempt. Integrate with `Log::channel('single')` or `Sentry` for centralized monitoring.
- Can I use Symfony Webhook for Laravel’s API routes without middleware bloat?
- Yes. For inbound webhooks, define a route (e.g., `Route::post('/webhook', [WebhookController::class, 'handle']))` and validate in the controller: `$webhook = new Webhook($request->getContent(), $request->headers->get('X-Signature')); if (!$webhook->validate(config('webhook.secret'))) { return response()->json(['error' => 'Invalid'], 401); }` Avoid middleware if routes are simple.
- What are the performance implications of Symfony Webhook for high-volume outbound webhooks (e.g., 10K/day)?
- Symfony Webhook adds minimal overhead (~5–10ms per request). For 10K/day, use Laravel Queues to batch or parallelize webhooks. Benchmark with `Http::timeout(10)` and Symfony’s `RetryStrategy` (default: 3 retries). Monitor with `telescope` or `prometheus` to track latency. Async processing mitigates most bottlenecks.
- Are there Laravel-specific alternatives to Symfony Webhook, like spatie/webhook-client?
- Yes. `spatie/webhook-client` is Laravel-focused for *inbound* webhooks (e.g., GitHub) with built-in signature validation and event dispatching. Symfony Webhook, however, supports *both* inbound/outbound and offers retries/payload parsing out of the box. Choose `spatie` for simplicity or Symfony for broader features. Both integrate with Laravel’s service container.
- How do I secure webhook secrets (e.g., GitHub/GitLab) in Laravel’s config?
- Store secrets in Laravel’s `.env` (e.g., `WEBHOOK_GITHUB_SECRET=your_hmac_key`) and access them via `config('services.webhook.github')`. Use Symfony’s `Webhook` class with: `$webhook = new Webhook($payload, $request->header('X-Hub-Signature-256')); if (!$webhook->validate(config('services.webhook.github.secret'))) { abort(401); }` Never hardcode secrets in PHP files.
- Can Symfony Webhook handle rate-limiting or exponential backoff for outbound webhooks?
- Symfony Webhook supports retries via `RetryStrategy`, but rate-limiting requires custom logic. Use Laravel’s `Http` client with `retryWhen()`: `Http::withOptions(['timeout' => 10])->retry(3, 100)->post($url, $payload)`. For exponential backoff, combine with Symfony’s `RetryStrategy` or a library like `guzzlehttp/ringphp`. Monitor with `laravel-horizon` for queue-based retries.
Weaver
How can I help you explore Laravel packages today?