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

# OneSignal APIs

OneSignal is a customer messaging platform for sending push notifications, email, SMS, and in-app messages. Jentic publishes the only available OpenAPI specifications for OneSignal and keeps them validated and agent-ready. Two specs are covered: a full 55-endpoint API for managing apps, users, subscriptions, segments, templates, and notifications, and a minimal single-endpoint spec for creating a notification. Together they let agents send messages across push, email, and SMS channels, build and edit audience segments, manage user identities, transfer subscription ownership, and pull outcome analytics.

## For AI agents

Agents can send push, email, SMS, and in-app notifications, build and edit audience segments, manage users and subscriptions, and pull outcome analytics across OneSignal's full and minimal specs.

## Scope

Use for: Sending push, email, SMS, and in-app notifications through OneSignal and managing the apps, users, subscriptions, segments, templates, and outcome analytics behind those messages.

Not supported:
- in-product UI personalisation
- payments
- CRM contact storage
- SDK client integration
- real-time delivery webhooks

## APIs

| API | Category | Endpoints | Description |
| --- | --- | --- | --- |
| OneSignal API (Full) | communications | 55 | Manage OneSignal apps, users, subscriptions, segments, templates, and notifications across push, email, and SMS through the full 55-endpoint OneSignal API. |
| OneSignal API | communications | 1 | Send push notifications, email, SMS, and in-app messages to OneSignal audiences with a single notification creation endpoint. |

## Which API to use

| Need | API | Why |
| --- | --- | --- |
| Only need to send a notification | onesignal | The minimal spec exposes a single notification-creation endpoint, so the agent can be limited to sending and nothing else. |
| Manage apps, users, segments, subscriptions, or analytics | onesignal-api | The full 55-endpoint spec covers app, user, segment, subscription, template, and outcome operations beyond sending. |
| Create or edit audience segments before sending | onesignal-api | Segment create, update, and delete operations live only on the full spec; the minimal spec can reference existing segments by name but cannot manage them. |

## Cross-API use cases

### Build a segment then send to it

An agent creates or updates an audience segment on the full spec, then sends a notification targeted at that segment. The full spec manages the segment definition and the minimal spec issues the send, so audience curation and delivery run through OneSignal without leaving the platform.

Example prompt: Create a segment named 'Active iOS Premium' under app 'app-xyz' filtered to platform iOS and tag plan premium, then send a notification to that segment with heading 'Members-only drop'.

### Send a campaign and measure outcomes

An agent sends a notification, then pulls outcome analytics to evaluate the result. The minimal spec creates the send and the full spec returns aggregated outcome counts filtered by platform and attribution window, so a campaign and its reporting come from the same messaging platform.

Example prompt: Send a notification to the 'Lapsed Users' segment under app 'app-xyz', then pull outcome metrics for click over the following 7 days filtered to iOS.

### Onboard a user and notify them

An agent registers a new user identity and attaches a device subscription on the full spec, then sends that user a welcome notification. Identity management lives on the full spec and delivery on the minimal spec, so a single agent can complete both steps against OneSignal.

Example prompt: Create a user under app 'app-xyz' with external id 'cust-123', attach an existing iOS subscription, then send a welcome notification to that subscription.

## Why Jentic

- **Setup:** Wiring OneSignal by hand means managing its REST API key and building calls across the full 55-endpoint spec and the minimal send spec against api.onesignal.com yourself. With Jentic One you install once, add the OneSignal APIs you need from the Jentic directory, store the key once, and your agent calls them.
- **Permission scoping:** OneSignal puts the app id in the URL path on the full spec, so a rule in your own Jentic One instance can pin the agent to one app and one set of operations, for example sending and reading outcomes but not creating apps or exporting players. An agent that only needs to send can be limited to the minimal spec's single operation.
- **Credential handling:** Your OneSignal REST 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, and the same key covers both specs.
- **Discovery method:** Agents search the Jentic directory by intent such as 'create a onesignal segment' or 'send a onesignal push notification', and Jentic returns the matching operation from either spec with its input schema, so the agent calls the right endpoint without browsing the reference docs.

## Related vendors

- **Pusher** — Pusher Beams is an alternative push notification delivery platform for teams already standardised on Pusher infrastructure.
- **Pushover** — Pushover offers a simpler push API aimed at personal and developer use cases rather than multi-channel consumer campaigns.
- **Twilio** — Twilio is a broader messaging platform for SMS, voice, and email when a team needs channels beyond push and in-app.

## FAQ

### Which OneSignal spec should an agent use?

Use the minimal spec when the task is only to send a notification, since it exposes a single notification-creation endpoint. Use the full 55-endpoint spec when the agent needs to manage apps, users, subscriptions, segments, templates, or outcome analytics. Both authenticate with the same key, so an agent can start narrow and widen its allowed operations later.

### Does one credential cover both OneSignal specs?

Yes. Both specs use the same OneSignal REST API Key in the Authorization header, so a single stored credential covers every operation across the full and minimal surfaces. You do not need separate keys for sending versus managing segments or users.

### Why does Jentic publish OpenAPI specs for OneSignal?

OneSignal does not publish its own OpenAPI specification. Jentic generates and maintains both the full and minimal specs so that AI agents and developers can call OneSignal through structured tooling. Each spec is validated against the live API and kept up to date.

### Can an agent both build audiences and send messages?

Yes. The full spec creates, updates, and deletes segments and manages user identities, while either spec can then send a notification targeted at those audiences. This lets an agent curate an audience and deliver to it within OneSignal, rather than splitting the work across separate tools.

### What channels can OneSignal reach through these specs?

OneSignal delivers push notifications, email, SMS, and in-app messages. A single notification-creation request can target push, email, SMS, or in-app depending on the channel options supplied, so one integration reaches multiple channels for the same audience.

### Can an agent measure how a campaign performed?

Yes, through the full spec. Its outcomes endpoint returns aggregated counts for named outcomes filtered by time range, platform, and attribution window. An agent can send a notification and then pull the matching outcome metrics to report on the result.

### What is out of scope for the OneSignal specs?

The specs cover message sending and the apps, users, subscriptions, segments, and outcomes behind messaging. They do not cover in-product UI personalisation, payment processing, or CRM contact storage, and they do not replace the client SDKs used to register devices inside a mobile or web app.