OneSignal Push Notifications for Laravel 5

WARNING!

This project is not actively maintained as of 2018/12/12. I'd strongly urge you to consider a package that is, like berkayk/onesignal-laravel, _(*1)

Introduction

This project is a wrapper for the OneSignal v1 API. It supports all operations currently supported by the API., _(*2)

Installation (Laravel and Lumen)

Require the package with composer., _(*3)

composer require jmrieger/onesignal-laravel
composer update

Laravel Users:

Update config/app.php by adding the following entries., _(*4)

'providers' => [
    // ...
    jmrieger\OneSignal\OneSignalServiceProvider::class
];

'aliases' => [
    // ...
    'OneSignal' => jmrieger\OneSignal\OneSignalFacade::class
   ];

Lumen Users:

update bootstrap/app.php, adding the following entry, _(*5)

$app->register( \jmrieger\OneSignal\OneSignalServiceProvider::class );
class_alias( 'jmrieger\OneSignal\OneSignalFacade', 'OneSignal' );

Configuration

There are 3 settings that need to be updated: your default OneSignal app ID, the REST API key, and the User Auth Key. All of these items can be found in your Control Panel on the OneSignal site., _(*6)

First, publish the onesignal config:, _(*7)

php artisan vendor:publish

Place the 3 keys into your .env file, as such:, _(*8)

ONESIGNAL_APP_ID=
ONESIGNAL_REST_API_KEY=
ONESIGNAL_USER_AUTH_KEY=

Usage

There is a function for each of the OneSignal API calls. They are broken down here., _(*9)

Note: In all instances where an $app_id is asked for, omitting it will grab the default OneSignal App ID specified in the .env file, _(*10)

Apps

getApps() - Get all Apps for the user

$response = OneSignal::getApps();

getApp( $app_id ) - Get the given App

postapp( $data ) - Create a new App

putApp( $app_id, $data ) - Update an App

Players

getPlayers( $app_id, $limit, $offset ) - Get Players from an App

getPlayer( $id ) - Get Player of the given ID

postPlayer ( $data, $app_id ) - Add Player to an App

putPlayer( $data, $app_id ) - Update Player object for an App

postCSVExport( $app_id ) - Get a CSV dump of all Players for an App

postPlayerOnSession( $data ) - Start a new device session for this Player

postPlayerOnPurchase( $data ) - Track a new purchase for this Player

postPlayerOnFocus( $data ) - Increment the Players total session length

Notifications

getNotifications( $app_id, $limit, $offset ) - Get all Notifications for an App

getNotification( $id, $app_id ) - Get a Notification from an App

postNotification( $data, $app_id ) - Add a Notification to an App

$response = OneSignal::postNotification([
    "tags"                  =>  [ ["key" => "myKey", "relation" => "=", "value" => 1 ] ],
    "contents"              => ["en" => "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean et iaculis enim. Sed egestas porttitor laoreet."],
    "headings"              => ["en" => "Aliquam consectetur odio sed"],
]);