Weave Code
Onesignal Php Api Laravel Package
onesignal/onesignal-php-api
A PHP client for the OneSignal API that enables push notification delivery and management of users, segments, templates, devices, and apps from PHP or Laravel applications. Provides generated API methods and models for quick integration.
A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
Frequently asked questions about Onesignal Php Api
- How do I install onesignal/onesignal-php-api in a Laravel app?
- Install the package with Composer, then configure your OneSignal app ID and API key in a Laravel config file. Because this is not a Laravel-specific bundle, do not assume service-provider auto-discovery, a facade, or queue integration. Register the client as a singleton in your own service provider and wrap it behind an application-owned service before calling it from controllers or jobs.
- Does onesignal/onesignal-php-api support Laravel 10, Laravel 11, and PHP 8?
- The package is a plain PHP API client rather than a Laravel bundle, so Laravel version support mostly depends on your PHP and PSR HTTP client constraints. The assessment notes that supported PHP and Laravel versions are unclear, so verify the Composer requirements before committing. Pin the package version, test it in your target Laravel and PHP runtime, and lock dependencies.
- Is onesignal/onesignal-php-api officially maintained by OneSignal?
- That should not be assumed from the package name alone. The assessment flags the repository as unknown and community traction as low at around 34 stars. Verify official status, the support channel, and any SLA directly with OneSignal before relying on it for production push delivery.
- What license does onesignal/onesignal-php-api use?
- The assessment flags the license as NOASSERTION, which means the applicable license is not clearly declared in the evaluated metadata. Legal review is mandatory before adoption, especially for commercial SaaS use or redistribution. Check the package metadata and repository for an explicit license before shipping it.
- Can I send OneSignal push notifications from a Laravel queue job with this package?
- Yes, the package can be used as the outbound API client inside a queued Laravel job or event listener. The package itself does not appear to provide Laravel queue integration, so your application should dispatch jobs and call the client through an application service. Use environment-specific OneSignal apps and keep app ID and API key in configuration rather than code.
- How should I structure a Laravel integration around the OneSignal PHP client?
- Place the client behind an application-owned interface such as PushNotificationGateway, bind it as a singleton in a service provider, and map OneSignal responses into internal result objects. Keep generated endpoint classes out of controllers, domain services, and business logic. This wrapper also lets you replace the SDK with direct HTTP calls or another client if needed.
- Does onesignal/onesignal-php-api handle retries, timeouts, idempotency, and rate-limit backoff?
- The assessment indicates the package likely handles request construction but not your application-level retry policy, idempotency keys, rate-limit backoff, observability, or secret rotation. Implement those concerns in your Laravel job, gateway wrapper, and PSR-compatible HTTP client configuration. Configure explicit timeouts and structured error handling instead of relying on SDK defaults.
- How do I test or mock OneSignal notification sends in Laravel?
- Mock your own PushNotificationGateway interface or inject a fake PSR-compatible HTTP client so tests do not call OneSignal. Since this is not a Laravel-specific package, do not assume a built-in facade fake or Laravel testing helper. If available, use a OneSignal sandbox app for contract tests covering notification, segment, device, and template calls.
- Which OneSignal API version and authentication model does this client target?
- You must verify the targeted OneSignal API version and authentication model from the package documentation and source before committing. The assessment calls out API-version drift and unclear API-version support as risks. Confirm how app ID, API key, and any newer OneSignal authentication requirements are supplied by the client.
- What are alternatives to onesignal/onesignal-php-api for Laravel push notifications?
- Alternatives include calling the OneSignal REST API directly with Laravel's HTTP client or Guzzle, using a more actively maintained OneSignal SDK, or wrapping push delivery behind your own notification abstraction. Given the low community traction and unclear license noted in the assessment, a gateway wrapper is the safest way to trial this package. That wrapper lets you switch to direct HTTP calls or another client without rewriting business logic.
Weaver
How can I help you explore Laravel packages today?