Push
Javascript

Intro

This page will help you configure your E-goi Push Application that will be used to send Push campaigns to your contacts.

Last update: 25/05/2021

What is a Push Notification?

A Push Notification is a message that the OS displays outside your app’s UI to provide the user with the reminders, communication from other people, or other timely information from your app. Users can tap the notification to open your app.

Firebase

Our Push channel uses Firebase to deliver the notifications to the user’s devices. You will need to create a Firebase project and integrate your app with it. To do that read this documentation in Firebase’s page:

Google Service Account

After configuring Firebase in your apps, you will need to create a Google Service Account with the right permissions. This Service Account will be used by us to get authorization on Firebase to send Push Notifications to your specified apps in your behalf. Follow the steps bellow to create the Service Account:

  1. Go to the settings page of the Firebase project you configured in the previous step;

  2. On the top menu, select “Service accounts” and then on Manage service account permissions:

    Service Account Menu

  3. The Google Cloud Platform will open on the “Service Accounts” section. Click on “+ CREATE SERVICE ACCOUNT”:

    Service Account Button

  4. Fill the data on Step 1 and click on “CREATE”:

    Service Account Step 1

  5. On Step 2, pick the permission Firebase SDK Provisioning Service Agent from the Role dropdown. This permission will allow us to only get permission to send Push Notifications from your account. After picking the permission, click DONE to finish the creation of the service account:

    Service Account Permission

  6. You should now se the service account created on the list of service accounts. Click on the three dots on the right side of the service account and then on Create Key. A modal will open with two key types to pick from. Pick the JSON one and click CREATE. A file will be automatically downloaded to you computer. It is important to save this file since it will be used in the creation of your E-goi Push Application:

    Key Modal

The creation of the Service Account is completed!

E-goi Push Application

Our Push Applications is simply an identifier to your actual app. This application enables you to do the following things inside E-goi:

Creating an E-goi Push Application is really simple! Just follow the steps bellow, and you will have an app created in no time:

  1. Login in your E-goi Account;

  2. Go to the Push Apps page - Apps > Push Apps on the top menu;

  3. Click on Add app dropdown location in the top right corner of the page and then on My current app:

    My Current App

  4. Fill the form related to the app info and click NEXT > after:

    App Info

  5. On the Step 2, upload the json file that you generated in the previous section. Click Save.

After following the steps above, you should have a Push Application configured in your account.

Libraries

To fully use our E-goi Push Channel, you should implement our libraries. All the documentation necessary to configure the library is located on the README.md file of each repository.

API Push Routes

We have integrated all Push API documentation and routs on the API V3. Simply follow this link to learn more.