OneSignal API
Browse all Onesignal APIs★ Only Publicly Available OpenAPI DocumentCommunicationsPush NotificationsapiKey1 EndpointsREST
For Agents
Send push notifications, email, SMS, and in-app messages to OneSignal audiences with a single notification creation endpoint.
Use for: I want to send a push notification to all subscribed users, Send a push to a specific OneSignal segment, Schedule a push for tomorrow at 9am UTC, Send an in-app message to users who match a tag filter
Not supported: Does not handle subscription import, segment editing, or message analytics — use for OneSignal notification creation only.
Jentic publishes the only available OpenAPI specification for OneSignal API, keeping it validated and agent-ready. This minimal OneSignal entry exposes the core POST /notifications endpoint for sending push, email, SMS, or in-app messages to registered users, segments, or specific subscription ids. The endpoint accepts the OneSignal app id, target audience parameters, message content, and channel-specific options, and returns the created notification id along with delivery counters.
Install Jentic One Beta
Connect the OneSignal API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the OneSignal 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 OneSignal API.
Send push notifications to OneSignal segments or specific subscription ids
Target users by tag filters when creating a notification
Schedule a notification for future delivery via the send_after parameter
Send multi-channel notifications including email and SMS through OneSignal
Return delivery counters from the notification creation response
Use Cases
Patterns agents use OneSignal API for, with concrete tasks.
★ Transactional Push Notifications
Send order updates, password resets, and account notifications to specific OneSignal subscription ids using POST /notifications. The endpoint accepts the app id, target subscription ids, headings, contents, and optional data payloads, returning the created notification id for tracking.
Send a push notification with heading 'Order shipped' and body 'Your order is on its way' to subscription id 'abc-123' under app id 'app-xyz'.
Segment-Targeted Campaigns
Reach a curated audience of OneSignal subscribers by passing segment names or tag filters in the create-notification request. Segments are managed inside the OneSignal dashboard and referenced by name in the API call, so marketing teams can update audiences without redeploying code.
Send a notification to the 'Active Subscribers' segment with heading 'Weekly Update' and a deep link to the new content.
Agent-Driven Push via Jentic
Customer engagement agents send OneSignal notifications through Jentic without holding the REST API key. The agent searches for the send-notification intent, loads the schema, and executes the call with the message content supplied by upstream tooling.
Use Jentic search 'send onesignal notification' to locate POST /notifications, load the schema, and execute with the supplied app id and content.
Key Endpoints
1 endpoints — jentic publishes the only available openapi specification for onesignal api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/notifications
Create a notification across push, email, SMS, or in-app channels
POST
/notifications
Create a notification across push, email, SMS, or in-app channels
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
OneSignal REST API keys are stored encrypted in the Jentic vault (MAXsystem). Agents only receive a scoped reference, so the raw key never enters prompts or logs.
Intent-based discovery
Agents search Jentic for 'send push notification onesignal' and Jentic returns the POST /notifications operation with its full input schema, ready to execute.
Time to first call
Direct integration: a few hours for auth and audience targeting plumbing. Through Jentic: under 15 minutes — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using OneSignal API through Jentic.
Why is there no official OpenAPI spec for OneSignal API?
OneSignal does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call OneSignal 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 OneSignal API use?
The API uses an apiKey credential — the OneSignal REST API Key sent in the Authorization header. Through Jentic the key lives encrypted in the vault (MAXsystem) and the agent only ever holds a scoped reference.
Can I send push notifications with this OneSignal spec?
Yes. POST /notifications accepts the app id, audience parameters such as segments or subscription ids, message content, and channel options, then queues the notification for delivery.
How do I target a OneSignal segment via the API?
Pass an included_segments array in the POST /notifications body with the segment names defined in the OneSignal dashboard. Combine with filters for finer targeting.
What are the rate limits for the OneSignal API?
Rate limits are not declared in this OpenAPI spec. Consult documentation.onesignal.com for current REST API rate limits before driving high-volume sends.
How do I send a notification through Jentic?
Run pip install jentic, search 'send onesignal notification', then load the POST /notifications schema and execute with the app id and message content. Jentic injects the REST API key from its vault.
GET STARTED