Push Notifications on Web for Programmable Chat

Push Notifications on Web

Push notifications are an important part of the web experience. Users have grown accustomed to having push notifications be a part of virtually every app that they use. The JavaScript Programmable Chat SDK is built to have Firebase Cloud Messaging (FCM) push notifications integrated into it. Managing your push credentials is necessary as your registration token is required for the Chat SDK to be able to send any notifications through FCM. Let's go through the process of managing your push credentials.

Step 1 - Enable push notifications for your Service instance

IMPORTANT: The default enabled flag for new Service instances for all Push Notifications is false. This means that Push will be disabled until you explicitly enable it. Follow this guide to do so.

Step 2 - Configure Firebase

The developer must configure Firebase Cloud Messaging (FCM) before configuring notifications. Google provides an easy-to-use Firebase Console to manager Firebase services and configurations.

Step 3 - Upload your API Key to Twilio

Now that we have our app configured to receive push notifications, let's upload our API Key by creating a Credential resource. Check out the Credentials page in the Twilio console page to generate a credential SID using your API key.

Step 4 - Pass the API Credential Sid in your Access Token

This step is to ensure that your Chat JS SDK client Access Token includes the correct credential_sid - the one you created in Step 3 above. Each of the Twilio Helper Libraries enables you to add the push_credential_sid. Please see the relevant documentation for your preferred Helper Library for the details. Here is an example using the Node.js Twilio helper Library:

var chatGrant = new ChatGrant({
    serviceSid: ChatServicesSid,
    pushCredentialSid: FCM_Credential_Sid,
});

Step 5 - Initialize Firebase in your web app

Now it's time to initialize the Firebase with sample code from Step 2 above.

In your web app's early initialization sequence, call the sample code (and do not forget to include/import the Firebase library provided by Google). We recommend including an additional check for the correct import of the Firebase libraries.

  // Initialize Firebase
  var config = {
    apiKey: "...",
    authDomain: "...",
    databaseURL: "...",
    projectId: "...",
    storageBucket: "...",
    messagingSenderId: "..."
  };
  if (firebase) {
    firebase.initializeApp(config);
  }

Step 6 - Request push permissions from the user and get your FCM token

In this step, we are requesting permission from the user to subscribe to and to display notifications. Again, we recommend adding checks for the correct initialization of Firebase.

 if (firebase && firebase.messaging()) {
      // requesting permission to use push notifications
      firebase.messaging().requestPermission().then(() => {
        // getting FCM token
        firebase.messaging().getToken().then((fcmToken) => {
          // continue with Step 7 here 
          // ... 
          // ... 
        }).catch((err) => {
          // can't get token
        });
      }).catch((err) => {
        // can't request permission or permission hasn't been granted to the web app by the user
      });
    } else {
      // no Firebase library imported or Firebase library wasn't correctly initialized
    }

Step 7 - Pass the FCM token to the Chat JS SDK and register an event listener for new push arrival

If you got to this step, then you have Firebase correctly configured and an FCM token ready to be registered with Chat SDK.

This step assumes that you have Chat Client created with correct Access Token from Step 4.

// passing FCM token to the `chatClientInstance` to register for push notifications
chatClientInstance.setPushRegistrationId('fcm', fcmToken);

// registering event listener on new message from firebase to pass it to the Chat SDK for parsing
firebase.messaging().onMessage(payload => {
    chatClientInstance.handlePushNotification(payload);
});

Next: Webhook Events