canonical: https://jentic.com/apis/aimtell.com/aimtell-api # Aimtell API 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. ## For AI agents Send web push notifications, manage subscribers and segments, and run event-triggered or RSS-driven push campaigns across browsers. ## Scope Does not handle SMS, email delivery, or in-app notifications - use for browser-based web push notifications and their campaigns only. ## Capabilities - 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 ### 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. Example prompt: 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. Example prompt: 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. Example prompt: 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. Example prompt: 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. Example prompt: 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 | 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 | ## Key resources - **Push Notifications** — Send one-off pushes to subscribers or segments via /prod/push/ - **Event Campaigns** — Push campaigns triggered by tracked subscriber events - **RSS Notifications** — Campaigns that push every new item from an RSS feed - **Sites** — Site-level configuration that scopes subscribers and campaigns - **Segments** — Subscriber segments built from attributes and events - **Settings** — Account-level configuration covering prompts, pixels, and integrations ## Why Jentic - **Setup:** Wiring Aimtell by hand means handling its API key, building push and campaign payloads, and writing your own retry logic. Through Jentic you install once, import Aimtell from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** Aimtell puts the campaign and notification ids in the URL path (/event-campaign/{id}/results, /rss-notification/{id}), so a rule can pin your agent to one campaign or notification. You choose the operations it may call, so sending a push is only included if you add it. - **Credential handling:** Your Aimtell API 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 web push notification', and Jentic returns the Aimtell /prod/push/ operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **OneSignal API** — Push and messaging platform across web, iOS, and Android - **Pusher API** — Realtime messaging including push notifications and channels - **Firebase Cloud Messaging** — Google's cross-platform messaging and push service ## FAQ ### 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 with Jentic One, the self-hosted execution layer. ### 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. Run it through Jentic One, the self-hosted execution layer. ### 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. ### Can I limit what my agent is allowed to do with the Aimtell API? Yes. Because you run Jentic One yourself, your own rules decide which Aimtell operations and credentials the agent may use, so sending a push via POST /prod/push/ is only available if you add it. Since Aimtell carries campaign and notification ids in the URL path, such as /event-campaign/{id}/results and /rss-notification/{id}, you can pin the agent to a single campaign or notification rather than the whole account. That lets you allow read-only reporting while withholding the ability to create or update campaigns.