Onesignal Rest API MCP server

Connect Onesignal Rest API to Claude, ChatGPT, Cursor, Claude Code, Codex, Gemini, GitHub Copilot and any other MCP client, for your whole team. Metorial adds security, governance, and tracing, and gives everyone one Magic MCP URL to connect.

What you can do with the Onesignal Rest API MCP server

Ask your agent in plain language. Each of these maps to a real tool on the server.

  • Use the delete user tool in Onesignal Rest API
  • Use the get user tool in Onesignal Rest API
  • Use the create segment tool in Onesignal Rest API
  • Use the create app tool in Onesignal Rest API
  • Use the cancel notification tool in Onesignal Rest API
  • Use the delete template tool in Onesignal Rest API

Supported Tools

delete_user

Delete User

Permanently delete a user and all associated data by alias. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

get_user

Get User

Retrieve a user's profile, properties, identity, and all subscriptions by alias (external_id or onesignal_id). Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

create_segment

Create Segment

Create a dynamic audience segment with filter rules. Segments automatically update as users match the criteria. Combine filters with AND/OR operators. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

create_app

Create App

Create a new OneSignal app under your organization. Requires an Organization API Key. Optionally configure platform-specific push settings.

cancel_notification

Cancel Notification

Cancel a scheduled or in-progress notification by its ID. Only notifications that have not yet been fully delivered can be cancelled. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

delete_template

Delete Template

Delete a message template. Templates used in active Journeys cannot be deleted. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

create_subscription

Create Subscription

Add a new subscription (push device, email, or SMS) to an existing user. The user is identified by alias. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

view_notifications

View Notifications

Retrieve notification details and delivery analytics. Can list recent notifications with pagination or fetch a specific notification by ID with detailed outcome metrics. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

update_user

Update User

Update a user's properties such as tags, language, timezone, location, and country. Identify the user by alias label and alias ID. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

delete_segment

Delete Segment

Delete a segment by its ID. System (read-only) segments cannot be deleted. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

transfer_subscription

Transfer Subscription

Transfer a subscription from one user to another. Useful when a device changes ownership. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

delete_subscription

Delete Subscription

Remove a subscription (device/email/SMS) from a user permanently. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

create_user

Create User

Create a new user in OneSignal with optional identity, properties (tags, language, country), and subscriptions (push, email, SMS). Use update_user to change properties of an existing user. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

update_app

Update App

Update an existing OneSignal app's settings. Requires an Organization API Key.

create_template

Create Template

Create a reusable message template for push notifications, emails, or SMS. Templates simplify sending consistent messages across campaigns. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

get_app

Get App

Retrieve details for a specific OneSignal app by ID. Requires an Organization API Key.

update_subscription

Update Subscription

Update an existing subscription's token or enabled status. Subscription types are immutable; recreate the subscription to change its type. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

list_segments

List Segments

Retrieve all segments for the app with pagination support. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

get_template

Get Template

Retrieve the full details of a specific template by its ID. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

send_notification

Send Notification

Send a push notification, email, or SMS/MMS message through OneSignal. Supports targeting by segments, user aliases, filters, subscription IDs, email addresses, or phone numbers. Can include rich content like images, action buttons, and custom data. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

export_data

Export Data

Export user and subscription data as a CSV file. Returns a URL to download the gzip-compressed CSV. The file may take some time to generate and is available for 3 days. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

update_template

Update Template

Update an existing template's name, content, or other properties. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

list_apps

List Apps

Retrieve all OneSignal apps under your organization. Requires an Organization API Key.

list_templates

List Templates

Retrieve all message templates with optional channel filtering and pagination. Provide appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

update_user_aliases

Update User Aliases

Add or update external_id or custom aliases for an existing user. Use appId from list_apps with an Organization API Key, or Settings > Keys & IDs. Set an external_id before adding custom aliases. Conflicting aliases fail without merging users.

delete_user_alias

Delete User Alias

Remove an external_id or custom alias while retaining the user and subscriptions. The permanent onesignal_id cannot be removed. Use appId from list_apps with an Organization API Key, or Settings > Keys & IDs.

Connect Onesignal Rest API to your AI client

Every client uses the same Magic MCP URL, and so does any other MCP client. Add it once and sign in with SSO.

  1. Enable Onesignal Rest API in Metorial. In your Metorial portal, enable the Onesignal Rest API MCP server and sign in with the account that owns the data. Access stays governed by your team policies.
  2. Add a custom connector. Open Customize, then Connectors. Select Add, then Custom, then Web.
  3. Paste your Metorial MCP URL. Name it Metorial, paste your Magic MCP URL (<your-magic-mcp-url>) and continue.
  4. Sign in. Select Add and sign in to load Onesignal Rest API tools.

Run Onesignal Rest API through the Metorial gateway

One governed layer for every app your agents reach, not a separate connector per tool.

  • Give Onesignal Rest API and every other app to your whole team through one MCP gateway, behind your SSO.
  • Scope which teams and agents can use Onesignal Rest API tools with role-based access control, and trace every call.
  • Prefer to run it yourself? Metorial is open source and self-hostable.

More integrations teams use with Onesignal Rest API

Slack

Slack: connect with bot OAuth or user OAuth to work with messages, conversations, search, files, Canvases, Lists, profiles, reactions, reminders, and workspace productivity settings.

Salesforce

Manage CRM data including Accounts, Contacts, Leads, Opportunities, Cases, and custom objects. Create, read, update, and delete records. Query data using SOQL and search across objects using SOSL. Perform bulk data operations for large-scale imports, exports, and migrations. Execute composite requests to batch multiple operations in a single API call. Access analytics, reports, and dashboards. Manage files and attachments associated with records. Interact with Chatter feeds, posts, and groups for social collaboration. Manage org metadata including custom objects, fields, layouts, and workflows. Query data using GraphQL for precise data retrieval across related objects.

Apolloio

Search and prospect B2B contacts and companies from a database of over 275 million people and 70 million organizations. Enrich people and company data with emails, phone numbers, and firmographic details. Create and manage contacts, accounts, deals, and tasks. Add contacts to email sequences and manage sequence statuses. Log and search call records. Perform bulk operations for contact creation, account creation, task creation, and data enrichment.

Sharepoint

Manage SharePoint sites, document libraries, lists, and files. Create, read, update, and delete lists and list items with custom columns. Resolve site users to numeric Person/Group LookupId values. Upload, download, move, copy, and version files in document libraries. Search across sites, files, folders, lists, and list items using Microsoft Search. Manage permissions at site, list, and item levels with granular access control. Define and manage content types and site columns. Retrieve site properties and search for sites across Microsoft 365.

Microsoft Outlook

Send, read, reply to, forward, and manage email messages in user mailboxes. Organize messages into folders, apply categories, flags, and importance levels. Manage file and item attachments. Create, update, delete, and respond to calendar events and meetings. Find available meeting times, manage attendees, handle recurrence, and work with shared or delegated calendars. Create, read, update, and delete contacts, organize them into contact folders, and manage contact photos. Manage tasks and task lists via Microsoft To Do, including due dates, reminders, recurrence, and checklist items. Support for Focused Inbox, @-mentions, mail tips, send-on-behalf, and send-as capabilities.

Hubspot

Create, read, update, and delete CRM objects including contacts, companies, deals, tickets, and custom objects. Manage associations between CRM records. Track engagements such as calls, emails, meetings, notes, and tasks. Send transactional and marketing emails, manage campaigns, and handle subscription preferences. Build and manage marketing workflows, sequences, and automation actions. Manage CMS content including blog posts, landing pages, and HubDB tables. Handle commerce data including products, orders, invoices, quotes, and payments. Create and manage contact lists for segmentation. Configure deal, ticket, and order pipelines with custom stages. Search and filter CRM records. Bulk import and export CRM data. Manage users, teams, and account settings.

Technical notes for Onesignal Rest API

Send push notifications, emails, and SMS/MMS messages. Manage users, aliases, subscriptions, audience segments, message templates, and apps. Retrieve message delivery analytics and downloadable subscription CSV exports. App management and app discovery require an Organization API Key; messaging and audience tools require an App API Key.

Frequently asked questions

Common questions about connecting Onesignal Rest API to AI agents with Metorial.

  1. How many tools does the Onesignal Rest API MCP server have?
    The Onesignal Rest API MCP server exposes 26 tools, including Delete User, Get User, Create Segment. Each one is governed and traced through Metorial.
  2. Onesignal Rest API exposes tools your agents call on demand; it does not publish event triggers yet. Everything still runs through one governed MCP URL.
  3. Any MCP client, including VS Code, Windsurf, Zed, OpenCode and Grok. Each one reaches the Onesignal Rest API MCP server through the same Metorial URL.
  4. Use role-based access control to decide which teams, users, and agents can use Onesignal Rest API and which of its tools they can call.
  5. Yes. Metorial is open source, so you can run the Onesignal Rest API MCP server yourself or use the hosted gateway.

Connect Onesignal Rest API to production AI agents

See how Metorial gives your team governed access to Onesignal Rest API, with tracing and security controls built in.