Getting Started#

Introduction#

PushEngage is a push notification platform for websites. This API documentation provides instructions how to use Rest APIs and JavaScript APIs.
There are only a couple of requirements for using the PushEngage APIs. You need to have a PushEngage account, and you need the PushEngage Javascript installed on your website.

Pre Requirement for Rest APIs

The PushEngage REST APIs is very easy to use, and you will need two things to get started:

  • Your PushEngage API Key, which is located on the PushEngage dashboard under Settings → Get API Key.
  • A computer where you can make curl calls.

API Key#

API key allows you to access our database, kind of like a username and password. When you sign up for our service, we provide you with a unique set of API keys. These can be found under Settings in your PushEngage dashboard.

Note

API Key is similar to "hdjhjxI3V5H4FVSFme1UlHN1d1OK59tQbcjh".

Supported Browsers#

PushEngage currently supports web push in the following browsers:

Chrome

  • Chrome on Mac OS X
  • Chrome on Windows
  • Chrome on Linux
  • Chrome on Android

Firefox

  • Firefox on Mac OS X
  • Firefox on Windows
  • Firefox on Linux

Safari

  • Safari on Mac OS X - Coming soon