canonical: https://jentic.com/apis/pushengage.com/pushengage

# PushEngage API

PushEngage push notifications API for managing subscribers, segments, notifications, and campaigns. The API exposes 10 endpoints secured with apiKey authentication.

## For AI agents

Programmatically send notification, schedule notification. Covers 10 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for marketing only.

## Capabilities

- Send notification
- Schedule notification
- List notifications
- Get subscriber
- Add subscriber to segment
- Create segment

## Use cases

### Marketing Operations

Use the PushEngage API to perform marketing operations programmatically. The API provides 10 endpoints covering core functionality including send notification, schedule notification, list notifications.

Example prompt: Call POST `/apiv1/notifications/send` to send notification

### Automated Analytics Management

Automate analytics operations by combining multiple PushEngage API endpoints. Agents can schedule notification and then list notifications in a single workflow.

Example prompt: Call POST `/apiv1/notifications/schedule` to schedule notification, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call PushEngage API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'send notification', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/apiv1/notifications/send` | Send notification |
| POST | `/apiv1/notifications/schedule` | Schedule notification |
| GET | `/apiv1/notifications` | List notifications |
| GET | `/apiv1/subscribers` | List subscribers |
| GET | `/apiv1/subscribers/{subscriberHash}` | Get subscriber |
| POST | `/apiv1/subscribers/{subscriberHash}/segments` | Add subscriber to segment |
| POST | `/apiv1/segments` | Create segment |
| GET | `/apiv1/segments` | List segments |

## Key resources

- **Analytics** — Operations related to Analytics
- **Notifications** — Operations related to Notifications
- **Segments** — Operations related to Segments
- **Subscribers** — Operations related to Subscribers

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 68 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 50 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/pushengage.com/pushengage/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring PushEngage by hand means sending its X-API-Key header on every request and handling notification, subscriber, and segment calls yourself. Through Jentic you install once, import the PushEngage API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** PushEngage puts the subscriber hash in the URL path (`/apiv1/subscribers/{subscriberHash}`), so a rule can pin your agent to one subscriber: it can read that subscriber or add it to a segment and nothing else. You choose the operations it may call, so sending or scheduling notifications is not included unless you add it.
- **Credential handling:** Your PushEngage key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a push notification' or 'create a subscriber segment', and Jentic returns the matching PushEngage operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp** — Alternative marketing API
- **Hubspot** — Alternative marketing API

## FAQ

### What authentication does the PushEngage API use?

The PushEngage API uses an API key passed in the `X-API-Key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I send notification with the PushEngage API?

Yes. Use the POST `/apiv1/notifications/send` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the PushEngage API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I send notification through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'send notification'. Jentic returns the matching PushEngage API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the PushEngage API have?

The PushEngage API exposes 10 endpoints covering analytics, notifications, segments operations.

### Can I limit what my agent is allowed to do with the PushEngage API?

Yes. Because you run Jentic One yourself, you decide which PushEngage operations your agent may call, so sending or scheduling notifications is excluded unless you add it. Since PushEngage puts the subscriber hash in the URL path (`/apiv1/subscribers/{subscriberHash}`), you can pin the agent to a single subscriber, letting it read that subscriber or add it to a segment and nothing more. Your own rules and stored credentials govern every call the agent is allowed to make.