Skip to main content

Getting Started

PushEngage offers a comprehensive set of REST APIs that facilitate integration with your existing systems. With these APIs, you can:

  • Create and view notifications
  • Manage segments: Including creation, deletion, and viewing.
  • Monitor subscriber status
  • Access subscriber analytics
  • Manage drip auto-responders
  • Update campaign products for events such as price drops and back-in-stock alerts.

Additionally, there are many more features and functionalities you can explore and utilize.

Prerequisite: API Key​

Before diving into the REST APIs, it's essential to comprehend the significance of the API key.

An API key is a unique identifier provided by PushEngage for each site. It acts as an authentication token, allowing your application to interface with the PushEngage platform. This key ensures that the requests made are authenticated and originate from a known and trusted source: your site.

🔒 Security Note: Given its sensitive nature, it's crucial to handle your API key with the utmost care. Always store it securely on the server side. Never expose it on the client side to prevent potential unauthorized access or malicious actions.

🔑 To retrieve your API Key, navigate to Site Settings » Site Details, and you will find the API Key section here.

Last updated on