This page will help you configure your E-goi Push Application that will be used to send Push campaigns to your contacts.
Last update: 23/09/2022
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.
Our notifications are silent Push notifications that display with no sound or visual alert. This type of notification is used due to the fact that these are passive, non time-related notifications. They do not require any interaction, as they are only informational.
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:
On the Step 2 of the Firebase documentation, you should pick Cloud Messaging from the list presented since it is the module used to send Push notifications.
Add firebase configs to your project
Add firebase configs to your project
First, connect an iOS app to your Firebase project.
Upload the APN authentication key to Firebase. If you don’t already have an APN authentication key, create one in the Apple Developer Member Centre.
Select the Gear Icon, Project Settings, and the Cloud Messaging tab in your Firebase Console project.
Go to your iOS app Settings. Under APN authentication key, click the upload button.
Navigate to the location where you saved the key, select it, and click on Open. Add the key ID available in the [Apple Developer Member Centre](https://developer.apple. and click on upload.
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:
Go to the settings page of the Firebase project you configured in the previous step;
On the top menu, select “Service accounts” and then on Manage service account permissions:
The Google Cloud Platform will open on the “Service Accounts” section. Click on “+ CREATE SERVICE ACCOUNT”:
Fill the data on Step 1 and click on “CREATE”:
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:
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:
The creation of the Service Account is completed!
Our Push Applications is simply an identifier to your actual app. This application enables you to do the following things inside E-goi:
Register device tokens of the users in the E-goi’s contacts list identified by the E-goi Push Application you created. This allows you to have contact lists with multiple tokens of different apps;
Target the application when creating a Push campaign so that the notifications will only be sent to the tokens of that application;
Register interactions of the users with the campaigns to display on the report of the campaign;
Creating an E-goi Push Application is really simple! Just follow the steps bellow, and you will have an app created in no time:
Login in your E-goi Account;
Go to the Push Apps page - Apps > Push Apps on the top menu;
Click on Add app dropdown location in the top right corner of the page and then on My current app:
Fill the form related to the app info and click NEXT > after:
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.
Native App is a specific development programmed in the native language in use by the system. The main objective of a Hybrid App is to combine elements of native and Web apps, enabling them to meet almost every functionality of a native application.
Some points to take into account when configuring a Native App:
Once you’ve installed the Libraries in the app, they will automatically integrate with Firebase, which will issue a Token similar to the one shown below (This token will be attached to the App in your E-goi account, attaching it to a contact).
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.
Hybrid Apps are based on frameworks with varying characteristics. These are not supported by the libraries we provide, so you’ll have to integrate them manually, as automated integration is not provided.
In the first phase, add the subscriber’s token to E-goi so that it can be attached to a contact. Use the (See here) token registration API to do so. This token will be attached to the app created in your E-goi account, which also attaches to a contact.
Example of Firebase Token:
dy-v5fAOTGaze2Q1nGwz6F:APA91bF8unmeMz6NdF00VANrf8CX9qxwjwnyh1w3e_6n12c1p6xh_xscyoscikf8zpy8r7lhyslh3tg7llt1h9vupz3yivfh_gau8y0agj9uvxibq59abtaqlt49fvx00dyvu_invz9m
To integrate notifications, bear in mind that these are silent push notifications, which means they first have to be interpreted to pop up on the subscriber’s screen. To interpret the notifications, follow the code available in the (Android or iOS) libraries
Example Frameworks: React Native, Ionic, Cordova, Flutter
| Field | Description |
|---|---|
| message-id | Campaign ID |
| message-hash | Campaign Hash |
| mailing-id | Campaign operation ID |
| application-id | Application ID |
| account-id | Customer ID |
| list-id | List ID |
| contact-id | Subscriber UID |
| device-id | Device ID (subscriber+token) |
| os | Operating system (Android or iOS) |
| key | ID that identifies the notification as being from E-goi (E-GOI_PUSH) |
| title | Notification title |
| body | Notification text |
| image | Notification image |
| actions | Actions to display in the notification (see here) |
| duration | Validity of georeference notification |
| longitude | Longitude coordinates |
| latitude | Latitude coordinates |
| radius | Geolocation radius |
To allow for more information about Subscriber interactions to be contained within The Push campaign report, Push events should also be integrated via the event log API (See here).
As soon as you add the App to E-goi you can create the campaign and test delivery (directly via the Editor).
We have integrated all Push API documentation and routs on the API V3. Simply follow this link to learn more.
Marketing Automation for Everyone! Capture, Automate, Communicate, Analyse and Generate more Sales.
Create Account
