OneSignal REST API
The OneSignal REST API enables developers to programmatically send push notifications, emails, and SMS, manage users and subscriptions, and configure apps.
Verdict
Common use cases
- Send launch announcements to beta testers
- Audit device registrations before a campaign
- Pull delivery reports for yesterday's push
- Remove inactive devices from your app
- Update device tags for segmentation
Integration
- Vendor
- OneSignal REST API
- Category
- other
- Auth
- API_KEY
- Tools
- 8
- Composio slug
onesignal_rest_api
Tools
- Create Notification
Tool to create and send a onesignal push notification. use when you have your message and target audience ready to dispatch notifications.
- Delete Devicedestructive
Tool to delete a device (player) from a onesignal app. use when you need to remove a specific device by its player id.
- Update Device
Tool to update properties of an existing device. use when you need to modify device attributes after registration.
- View Device
Tool to retrieve details of a specific device (player). use when you have a onesignal player id and need current device info.
- View Devices
Tool to retrieve a paginated list of devices (players) for a onesignal app. use when you need to list or audit all registered devices for a given app.
- View Notifications
Tool to retrieve details of multiple notifications. use when you need to list notifications for a specific app.
- View OneSignal App
Tool to retrieve metadata for a single onesignal app. use when you need to fetch app details by its id.
- View Segments
Tool to view segments for a onesignal app. use when you need to list all segments associated with an app.
Setup
Setup guide
- 11. In Switchy, open your workspace settings and navigate to the Integrations tab. 2. Search for OneSignal REST API and click Connect. 3. You'll be prompted to paste your OneSignal REST API key—find this in your OneSignal dashboard under Settings > Keys & IDs (use the REST API Key, not the App ID). 4. Grant the integration access to the apps you want to manage; the key must have permissions to create notifications and read device data. 5. Click Save and return to any Space. 6. Test the connection by typing '@OneSignal view devices' and hitting send—you should see a paginated list of registered players. 7. To send a notification, use '@OneSignal create notification' followed by your message and target segment; the tool will confirm delivery and return a notification ID you can reference later.
What teammates see: by default, memories from OneSignal REST API are scoped to the Space (PROJECT visibility) - you can mark any memory PRIVATE or share it ORG-wide.
Works well with
Top models
Compatibility data appears once enough Spaces have used this MCP together with a given model.
How Switchy teams use it
Starter prompts
Send Launch Notification
@OneSignal create notification with the message 'Version 2.0 is live—check out the new dashboard' targeting the segment 'Active Users'. Confirm the notification ID once sent.Open in a Space →
List Recent Notifications
@OneSignal view notifications for our main app, showing the most recent ten. Include send time and delivery count for each.Open in a Space →
Audit Device Registrations
@OneSignal view devices for app ID abc123, returning the first 50 results. Show player ID, device type, and last active timestamp.Open in a Space →
Update Device Tags
@OneSignal update device with player ID xyz789, adding the tag 'premium_user' and setting language to 'en'. Confirm the update succeeded.Open in a Space →
Check App Metadata
@OneSignal view app details for app ID abc123. Show the app name, total player count, and timezone setting.Open in a Space →
Example outputs
Illustrative - representative of the model's voice and quality, not literal recordings.
@OneSignal REST API show me all devices registered in the last 24 hours for our mobile app
Retrieved 47 devices registered in the past day. The list includes device IDs, platform types (23 iOS, 24 Android), registration timestamps, and last active times. Most devices show active sessions within the past 6 hours. Language preferences span 8 locales, with en-US representing 62% of new registrations. All devices have valid push tokens and notification permissions enabled.
This example demonstrates read-only device auditing. The View Devices tool returns paginated results (default 300 per page), so large device bases require multiple calls. Requires API key with read permissions on the app. Useful for monitoring registration trends but won't show uninstalled apps that haven't been explicitly deleted.
@OneSignal REST API send a push notification to our 'weekend_shoppers' segment announcing the flash sale starts in 30 minutes
Notification created and dispatched to the 'weekend_shoppers' segment (estimated 1,842 recipients). Notification ID: 3f7a9c2e-4b1d-4a8f-9e3c-7d6f8a2b5c1e. Message: 'Flash Sale Alert! 30 minutes until deals go live. Open now for early access.' Delivery began immediately. You can track open rates and click-through metrics in the OneSignal dashboard within 5-10 minutes as devices receive and interact with the push.
This showcases the Create Notification tool's segment-targeting capability. The MCP sends the notification immediately—there's no undo once dispatched. Requires API key with create permissions. Segment must exist beforehand (use View Segments to confirm). Rate limits apply: free tier allows 10,000 notifications/month. Consider testing with a small segment first to verify message rendering.
@OneSignal REST API analyze our last 20 notifications and tell me which message types got the highest open rates
Analyzed 20 recent notifications spanning 14 days. Top performers: (1) Time-sensitive offers with countdown language averaged 34% open rate. (2) Personalized product recommendations hit 28% opens. (3) Generic announcements lagged at 12%. Notifications sent between 6-8 PM local time outperformed morning sends by 19 percentage points. Three notifications to the 'inactive_users' segment saw sub-5% engagement, suggesting that segment needs re-evaluation or removal.
This example pairs View Notifications (fetching raw notification metadata) with AI reasoning to surface patterns. The MCP provides notification IDs, send times, segment targets, and basic stats—the AI synthesizes trends. Requires read permissions. Open rate data may lag by several hours post-send. This workflow helps optimize messaging strategy but can't access individual user-level interaction data due to privacy constraints.
Use-case deep-dives
When you need to push urgent alerts to customer segments fast
A 6-person support team handling a service outage needs to notify affected users in under two minutes. OneSignal's Create Notification tool hits the right balance here: you can target by segment, fire the push, and move on without leaving your incident channel. The View Segments tool confirms you're hitting the right cohort before you send. This MCP works when your notification logic is simple (segment-based targeting, pre-written copy) and your team already manages segments in OneSignal's dashboard. If you need dynamic per-user personalization or complex conditional logic, you'll spend more time scripting than the MCP saves. For straightforward broadcast scenarios where speed matters and segments are stable, this is the call.
When a solo marketer needs to clean up stale device registrations
A solo growth marketer at a 10-person startup runs a weekly push campaign and notices delivery rates dropping. The View Devices tool surfaces the full player list; filtering by last_active reveals hundreds of devices that haven't opened the app in 90 days. The Delete Device tool removes them in batch. This scenario wins because the MCP exposes OneSignal's device registry without forcing the marketer into the web console or writing custom API scripts. The trade-off: if your app has over 10,000 devices, pagination gets tedious and you're better off exporting a CSV from OneSignal directly. For small to mid-scale apps where a human can review the list in one sitting, this MCP keeps device hygiene simple.
When you need to trace which pushes actually went out during a bug
A 4-person product team ships a feature Friday afternoon; by Monday, users report duplicate push notifications. The View Notifications tool pulls the weekend's send history, showing three identical pushes fired within an hour. The team cross-references timestamps with deploy logs and confirms a retry loop in their backend. This MCP is the right fit when your notification volume is low enough that a human can scan the list (under 500 sends per day) and your goal is forensic, not real-time monitoring. If you're sending thousands of pushes daily or need alerting on anomalies, you want a proper observability stack, not an MCP query. For small teams doing occasional post-mortems, this gets you the data without building a dashboard.
Frequently asked
What does the OneSignal MCP let me do in Switchy?
It lets you send push notifications, manage devices, and view segments directly from Switchy's AI workspace. You can create notifications with targeting rules, update device properties, delete inactive players, and audit your notification history without switching to the OneSignal dashboard. All eight tools work through OneSignal's REST API using your API key.
Do I need admin access to connect OneSignal?
You need a OneSignal REST API key with write permissions to use the full toolset. Read-only keys will let you view devices, notifications, and segments, but you won't be able to create notifications or modify device records. Generate the key from your OneSignal dashboard under Settings > Keys & IDs. Anyone with the key can connect the MCP.
Can the MCP send notifications to specific user segments?
Yes. The Create Notification tool supports OneSignal's full targeting syntax, including segments, filters, and individual player IDs. You can view your existing segments with the View Segments tool, then reference them when dispatching notifications. The MCP doesn't create new segments — you still define those in the OneSignal dashboard.
Why use this instead of OneSignal's dashboard or API directly?
Use the MCP when you want to trigger notifications or check device status as part of a larger workflow in Switchy — like sending a push after a Slack alert or auditing devices alongside customer data from another tool. For bulk operations or complex audience building, the OneSignal dashboard is faster. For one-off API calls, this saves you from writing curl commands.
Who on the team should connect this MCP?
Whoever manages your push notification campaigns or monitors device registrations. Typically a product manager, growth lead, or backend engineer. Since the API key grants full access to your OneSignal app, don't share the connection with people who shouldn't be able to send notifications to your entire user base. Each connection counts as one MCP slot in your Switchy plan.