Web Push library for PHP

composer require minishlink/web-push

WebPush can be used to send notifications to endpoints which server delivers web push notifications as described in the Web Push API specification. As it is standardized, you don't have to worry about what server type it relies on.

Currently, WebPush doesn't support payloads at all. It is under development (see "payload" branch). PHP 7.1 will be needed for some encryption features. Development of payload support is stopped until this PHP bug is fixed. If you need to show custom info in your notifications, you will have to fetch this info from your server in your Service Worker when displaying the notification (see this example).

<?php

use Minishlink\WebPush\WebPush;

// array of endpoints
$endpoints = array(
    'https://android.googleapis.com/gcm/send/abcdef...', // Chrome
    'https://updates.push.services.mozilla.com/push/adcdef...', // Firefox 43+
    'https://example.com/other/endpoint/of/another/vendor/abcdef...',
);

$webPush = new WebPush();

// send multiple notifications
foreach ($endpoints as $endpoint) {
    $webPush->sendNotification($endpoint);
}
$webPush->flush();

// send one notification and flush directly
$webPush->sendNotification($endpoints[0], null, null, true);

For compatibility reasons, this library detects if the server is a GCM server and appropriately sends the notification. GCM servers don't support encrypted payloads yet so WebPush will skip the payload. If you still want to show that payload on your notification, you should get that data on client-side from your server where you will have to store somewhere the history of notifications.

You will need to specify your GCM api key when instantiating WebPush:

<?php

use Minishlink\WebPush\WebPush;

$endpoint = 'https://android.googleapis.com/gcm/send/abcdef...'; // Chrome
$apiKeys = array(
    'GCM' => 'MY_GCM_API_KEY',
);

$webPush = new WebPush($apiKeys);
$webPush->sendNotification($endpoint, null, null, true);

Time To Live (TTL, in seconds) is how long a push message is retained by the push service (eg. Mozilla) in case the user browser is not yet accessible (eg. is not connected). You may want to use a very long time for important notifications. The default TTL is 4 weeks. However, if you send multiple nonessential notifications, set a TTL of 0: the push notification will be delivered only if the user is currently connected. For other cases, you should use a minimum of one day if your users have multiple time zones, and if you don't several hours will suffice.

<?php

use Minishlink\WebPush\WebPush;

$webPush = new WebPush(); // default TTL is 4 weeks
// send some important notifications...

$webPush->setTTL(3600);
// send some not so important notifications

$webPush->setTTL(0);
// send some trivial notifications

By default, WebPush will use MultiCurl, allowing to send multiple notifications in parallel. You can change the client to any client extending \Buzz\Client\AbstractClient. Timeout is configurable in the constructor.

<?php

use Minishlink\WebPush\WebPush;

$client = new \Buzz\Client\Curl();
$timeout = 20; // seconds
$webPush = new WebPush(array(), null, $timeout, $client);

You have access to the inner browser if you want to configure it further.

<?php

use Minishlink\WebPush\WebPush;

$webPush = new WebPush();

/** @var $browser \Buzz\Browser */
$browser = $webPush->getBrowser();

The following are available:

• Symfony: MinishlinkWebPushBundle

Feel free to add your own!

Not until the Push API spec is finished.

Your installation lacks some certificates.

1. Download cacert.pem.
2. Edit your php.ini: after [curl], type curl.cainfo = /path/to/cacert.pem.

You can also force using a client without peer verification.

WebPush is for web apps. You need something like RMSPushNotificationsBundle (Symfony).

This library was inspired by the Node.js marco-c/web-push library.

See CONTRIBUTING.md.

Copy phpunit.xml from phpunit.dist.xml and fill it with your test endpoints and private keys.

MIT