Firebase Push Notification

Component ID

2895424

Component name

Firebase Push Notification

Component type

module

Maintenance status

Development status

Component security advisory coverage

not-covered

Downloads

656

Component created

Component changed

Component body

Synopsis

Firebase implements a service to send push notification to Android or iOS devices.
It uses Google's Firebase Cloud Messaging to deliver the notification.

Firebase allows

  • to send push and silent push notifications
  • to customize icon, sound and click action
  • to send push notification

Module Setup

These are the steps to get the notifications working:

  1. Create a Firebase account
  2. Add Firebase to your iOS project OR Android project
  3. Enable this module
  4. Add your firebase Server Key into /admin/config/system/firebase
  5. Each device has a token. Store that token on Drupal
  6. Call Firebase service passing the device's token and message
// Token is generated by app. You'll have to send the token to Drupal.
$fakeToken = 'e3vUiwcvkpY:APA91bEDZzKTIkaL0e-UTwiV6EGi1m5J5PrDMxejm6-d85vdwE6Agd';
Drupal::service('firebase.notification')->send($fakeToken, [
  'title' => 'Title goes here',
  'body' => 'Body goes here',
  'data' => [
    'score' => '3x1',
    'date' => '2017-10-10',
    'optional' => 'Data is used to send silent pushes. Otherwise, optional.',
  ],
  'icon' => 'optional-icon',
  'sound' => 'optional-sound',
  'click_action' => 'optional-action',
  'badge' => 1,
]);