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.

Using an AI assistant?

You don't have to call these APIs by hand. The official PushEngage MCP server connects Claude, Cursor, and other MCP-capable assistants to your account, so you can send notifications, build segments, and pull analytics in plain language.

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.

Response Status Codes​

Every response from the https://api.pushengage.com/apiv1 endpoints is JSON and includes a success boolean. The HTTP status code reflects the outcome of the request, so you can rely on it to tell a successful call from a failed one. Most error responses also carry an error_code and a message in the body that describe what went wrong.

{
  "success": false,
  "error_code": "1001",
  "message": "Invalid API Key"
}
StatusWhen it happens
200 OKThe request succeeded.
400 Bad RequestThe request is invalid: a required parameter is missing, a value has the wrong type or format, or the Content-Type header is wrong.
401 UnauthorizedThe Api-Key header is missing, or the API key is invalid or inactive.
403 ForbiddenThe account is blocked or its plan has expired, or the feature is not available on your plan (for example, premium APIs on the Free plan, or a plan limit such as segments or notifications has been reached).
404 Not FoundThe requested resource does not exist, for example an unknown segment or a subscriber that is not found or has unsubscribed.
409 ConflictThe resource already exists, for example a segment with the same name.
429 Too Many RequestsYou have exceeded the rate limit. See Rate Limits below.
500 Internal Server ErrorSomething went wrong on our side while processing the request.
502 Bad GatewayAn internal service that PushEngage depends on failed to respond. Retry the request after a short wait.
503 Service UnavailableThe service is temporarily unavailable. Retry the request after a short wait.

Rate Limits​

Each site can make up to 300 requests per minute to the https://api.pushengage.com/apiv1 endpoints. When you exceed this limit, the API responds with 429 Too Many Requests and a Retry-After header that tells you how many seconds to wait before sending the next request.

Last updated on