Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the PushEngage API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fpushengage.com%2Fpushengage" | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fpushengage.com%2Fpushengage" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with PushEngage API.
Send notification
Schedule notification
List notifications
Get subscriber
Add subscriber to segment
GET STARTED
Create segment
Patterns agents use PushEngage API for, with concrete tasks.
★ 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.
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.
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.
Search Jentic for 'send notification', load the operation schema, and execute with Jentic-managed credentials
10 endpoints — pushengage push notifications api for managing subscribers, segments, notifications, and campaigns.
METHOD
PATH
DESCRIPTION
/apiv1/notifications/send
Send notification
/apiv1/notifications/schedule
Schedule notification
/apiv1/notifications
List notifications
/apiv1/subscribers
List subscribers
/apiv1/subscribers/{subscriberHash}
Get subscriber
/apiv1/subscribers/{subscriberHash}/segments
Add subscriber to segment
/apiv1/segments
Create segment
/apiv1/segments
List segments
/apiv1/notifications/send
Send notification
/apiv1/notifications/schedule
Schedule notification
/apiv1/notifications
List notifications
/apiv1/subscribers
List subscribers
/apiv1/subscribers/{subscriberHash}
Get subscriber
/apiv1/subscribers/{subscriberHash}/segments
Add subscriber to segment
/apiv1/segments
Create segment
/apiv1/segments
List segments
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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.
Alternatives and complements available in the Jentic catalogue.
Specific to using PushEngage API through Jentic.
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.
For Agents
Programmatically send notification, schedule notification. Covers 10 operations with apiKey authentication.
Use for: I need to send notification, I want to schedule notification, Search for notifications, Find all subscribers
Not supported: Does not handle payments, communications, or crm - use for marketing only.
PushEngage push notifications API for managing subscribers, segments, notifications, and campaigns. The API exposes 10 endpoints secured with apiKey authentication.
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.
Base layer of spec validity and structural soundness.
Aggregated quality score from linter diagnostics, weighted by severity.
Percentage of `$ref` references that resolve successfully.
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
Structural correctness score based on schema issues using logarithmic dampening.
Clarity, completeness, and ingestion readiness for developers and tooling.
How richly the API is illustrated with examples.
Percentage of examples that conform to their schemas.
Percentage of operations with complete response definitions (success, client error, server error).
Health of API ingestion, bundling, and resolution within Jentic pipelines.
Semantic breadth, depth, and agent comprehension for AI systems.
Coverage of descriptions across API elements.
Coverage of RFC 9457 Problem Details for error responses.
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
Coverage of summaries across operations/tags/info.
Functional utility, complexity comfort, and AI orchestration readiness.
Agent comfort level based on API operational and structural complexity.
Trust, risk posture, and security compliance.
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
Findability, semantic richness, and reasoning readiness.
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>