Weave Code
Api Laravel Laravel Package
helpscout/api-laravel
A Laravel integration for the Help Scout API, providing configuration, a service provider, and a facade for working with mailboxes, conversations, customers, and other Help Scout resources from your PHP applications.
Service Provider and Facade for using the Help Scout API with Laravel and Lumen applications.
Frequently asked questions about Api Laravel
- What is helpscout/api-laravel used for?
- It is a thin Laravel and Lumen integration for the Help Scout API. It registers the helpscout/helpscout-api-php client in the service container, provides a facade, and publishes configuration for credentials. The actual API resources and HTTP behavior come from the underlying SDK, not this wrapper.
- How do I install helpscout/api-laravel with Composer?
- Run composer require helpscout/api-laravel. On Laravel 5.5 and later the service provider and facade are auto-discovered, so no manual registration is usually needed. You should then publish the config file and add your Help Scout credentials to your environment file.
- Does helpscout/api-laravel support Lumen?
- Yes, but Lumen does not use package auto-discovery. You need to register the service provider and facade alias manually in bootstrap/app.php. This is the standard documented Lumen package pattern.
- Which Laravel and PHP versions does helpscout/api-laravel support?
- Support is governed by the package's illuminate/support constraint, which may lag behind the newest Laravel releases. Check the composer.json for the current release before adopting it on Laravel 10, 11, or 12. If the constraint is stale, you can drop the wrapper and bind the SDK client in your own service provider.
- How do I configure Help Scout API credentials in Laravel?
- Publish the package config with the vendor:publish command and set the generated Help Scout values in your .env file. The wrapper passes configuration through to the underlying SDK client. Keep credentials out of source control and use separate values per environment.
- Does helpscout/api-laravel handle Help Scout webhooks?
- No. The package is outbound-only and does not provide a webhook receiver, signature verification, idempotency, or replay handling. If you need to react to conversation or customer events, you must build and secure that endpoint yourself.
- Does helpscout/api-laravel handle rate limits and retries?
- No. The wrapper adds no retry, backoff, 429 handling, circuit breaking, or queueing. Calls through the facade are synchronous from the caller's perspective and are bounded by Help Scout's per-account rate limits. You should add backoff and queueing around fan-out loops to avoid production 429 errors.
- Which authentication method does helpscout/api-laravel use?
- Authentication is delegated to the underlying helpscout/helpscout-api-php SDK. Depending on the SDK version, this may be a personal access token or OAuth2 client credentials. The wrapper does not add token lifecycle management, so verify refresh behavior in the SDK before relying on OAuth2.
- Can I use helpscout/api-laravel without the facade?
- Yes. The package is roughly 40 to 80 lines of glue, so you can resolve the SDK client from the container or inject it directly. Many teams skip the wrapper entirely and register helpscout/helpscout-api-php in their own AppServiceProvider. That also removes the illuminate/support version constraint as a risk.
- Is helpscout/api-laravel actively maintained and safe for production?
- It is published under the Help Scout GitHub organization and has a recent release, which suggests first-party maintenance. However, it has very few stars and dependents, so community support depth is limited. For production, treat it as a convenience wrapper and budget a contingency to inline the SDK binding if needed.
Weaver
How can I help you explore Laravel packages today?