Aimtell API
Browse all Aimtell APIs★ Only Publicly Available OpenAPI DocumentCommunicationsPush NotificationsapiKey77 EndpointsREST
For Agents
Send web push notifications, manage subscribers and segments, and run event-triggered or RSS-driven push campaigns across browsers.
Use for: I need to send a push notification to all subscribers of a site, Create an event-triggered campaign that fires on cart abandonment, Set up an RSS-driven campaign that pushes new blog posts, Build a segment of subscribers who visited the pricing page
Not supported: Does not handle SMS, email delivery, or in-app notifications — use for browser-based web push notifications and their campaigns only.
Jentic publishes the only available OpenAPI specification for Aimtell API, keeping it validated and agent-ready. Aimtell is a web push notification platform that lets sites engage subscribers across Chrome, Safari, Firefox, and Android via browser push. The API spans a wide surface — sites, subscribers, segments, push campaigns, event-triggered campaigns, RSS-driven notifications, prompts, pixels, and account settings — exposed across 77 endpoints. Authentication uses an API key.
Install Jentic One Beta
Connect the Aimtell API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Aimtell 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.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | 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.
Capabilities
What an agent can do with Aimtell API.
Send a web push notification to subscribers via POST /prod/push/
Create event-triggered campaigns that fire when subscribers perform a tracked event
Configure RSS campaigns that automatically push the latest feed items as notifications
Build segments of subscribers by attributes and events for precise targeting
Manage sites, prompts, and pixels that capture and grow the subscriber base
Inspect campaign results by day to attribute opens and clicks back to the originating campaign
Use Cases
Patterns agents use Aimtell API for, with concrete tasks.
★ Cart Abandonment Push
Recover abandoned carts by triggering a web push when a tracked event fires. Create an event campaign with /prod/event-campaigns/ that targets a segment of users who reached checkout but did not complete, attach the offer message, and let Aimtell deliver the push. Day-by-day results are available via /prod/event-campaign/{id}/results.
POST /prod/event-campaigns/ with the segment id, message, and trigger event, then GET /prod/event-campaign/{id}/results daily to track recovery
RSS-to-Push for a Publisher
A publisher pushes every new article to opted-in browsers via RSS-driven campaigns. Configure the campaign with /prod/rss-notifications/, point it at the feed URL, and Aimtell handles polling and delivery. New posts appear as web push notifications without manual scheduling.
POST /prod/rss-notifications/ with the feed URL and target site id, then check /prod/rss-notification/{id} status periodically
Targeted Promotional Push
Run a one-off promotional push to a precise audience. Build a segment using /prod/segments, then POST /prod/push/ with the segment id and the message payload. The platform resolves the segment to subscribers across browsers and dispatches the push.
Create a segment matching pricing-page visitors, then POST /prod/push/ with that segment id and the promotional copy
Subscriber Growth via Prompts
Grow the push subscriber base by configuring opt-in prompts that appear on the site. Manage prompt configuration through the Aimtell prompt endpoints, and tie prompt impressions to attribution pixels. The combination keeps subscriber acquisition measurable without leaving the API.
Create a new prompt configuration via the prompts endpoints and confirm it is live for the target site
Agent-Driven Push Orchestration via Jentic
An AI agent runs a daily push playbook: build the segment, send the push, and report results. Through Jentic the agent searches for the right Aimtell operation, the API key is supplied from the vault, and the agent never sees the raw key.
Use Jentic search 'send a web push notification', execute /prod/push/, then poll /prod/event-campaign/{id}/results and post a summary to Slack
Key Endpoints
77 endpoints — jentic publishes the only available openapi specification for aimtell api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/prod/push/
Send a web push notification
POST
/prod/event-campaigns/
Create an event-triggered campaign
GET
/prod/event-campaign/{id}/results
Get event campaign results by day
GET
/prod/event-campaigns/{id}
List event-triggered campaigns for a site
GET
/prod/rss-notifications/{id}
List RSS campaigns for a site
PUT
/prod/rss-notification/{id}
Update an RSS campaign
POST
/prod/push/
Send a web push notification
POST
/prod/event-campaigns/
Create an event-triggered campaign
GET
/prod/event-campaign/{id}/results
Get event campaign results by day
GET
/prod/event-campaigns/{id}
List event-triggered campaigns for a site
GET
/prod/rss-notifications/{id}
List RSS campaigns for a site
PUT
/prod/rss-notification/{id}
Update an RSS campaign
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
The Aimtell API key is stored encrypted in the Jentic vault. Agents call /prod/push/, /prod/event-campaigns/, and /prod/rss-notifications/ through Jentic without ever seeing the raw key.
Intent-based discovery
Agents search 'send a web push notification' and Jentic returns the Aimtell /prod/push/ operation along with the matching segment lookup, so the agent can build and dispatch the campaign in two calls.
Time to first call
Direct integration: 2-3 days to navigate the 77-endpoint surface, model sites and segments, and wire campaign reporting. Through Jentic: under an hour.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Aimtell API through Jentic.
Why is there no official OpenAPI spec for Aimtell API?
Aimtell does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call the Aimtell API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.
What authentication does the Aimtell API use?
An apiKey scheme. The key is sent as a header on each request. Through Jentic the key is held in the vault and never enters the agent's context.
Can I send a one-off push to a segment?
Yes. Build a segment with the segments endpoints, then POST /prod/push/ with the segment id and the message payload. Aimtell resolves the segment to subscribers and dispatches the push across browsers.
What are the rate limits for the Aimtell API?
The spec does not declare explicit rate limits. Most endpoints are scoped to a site id, so concurrency is naturally bounded by the number of sites; respect HTTP 429 responses if you push high volumes.
How do I run an event-triggered campaign through Jentic?
Run pip install jentic, search 'create an event-triggered push campaign', execute /prod/event-campaigns/ with the segment id and trigger event, and poll /prod/event-campaign/{id}/results to report performance. Sign up at https://app.jentic.com/sign-up.
Can I push from an RSS feed automatically?
Yes. POST /prod/rss-notifications/ with the feed URL and the target site id. Aimtell polls the feed and pushes each new item to subscribers without further input.
GET STARTED