Your AI team, working in OneSignal User Auth

OneSignal is a customer engagement platform offering push notifications, email, SMS, and in-app messaging services.

Start your company

What your team can do in OneSignal User Auth

64 tools to work with, connected with an API key.

Bulk Update Message State

Update read, opened, or deleted state for a user's inbox messages in bulk. Changes apply to the entire inbox unless last_message_id is supplied, in which case they apply to that message and every older message. Each state can be changed independently. Requires the app's App API key. A 403 may also indicate a nonexistent app_id; an unknown alias lookup returns 404.

Cancel Message

Stop a scheduled or currently outgoing OneSignal message. Requires the app's App API key from connection metadata. Cancellation does not delete the message or remove notifications already delivered. If sending is in progress, some targeted users may still receive the message.

Copy Template to Another App

Duplicate a message template into another app in the same organization. Requires an Organization API key (Authorization: Key <organization key>) supplied by connection metadata and admin access to both apps. The target app must differ from the source app. The copy retains the original content but is independent of the original and receives a new template ID. Supports push, SMS, and both HTML and Drag & Drop email templates.

Create Alias by Subscription

Create or update aliases for a user identified by a known Subscription ID. Uses an App API key. Existing alias labels are updated immediately and new labels are added; omitted aliases remain unchanged. The Subscription must belong to the user whose identity should be updated. OneSignal ID is read-only. To remove an alias, use Delete Alias instead.

Create App

Create a OneSignal app with optional web, Android, and iOS push configuration. Requires an Organization API key (not an app REST API key) associated with organization_id. Email and SMS must be configured in the OneSignal Dashboard.

Create Custom Events

Record user events for Journeys, segments, personalization, and conversions using the app API key. HTTP 202 can contain individual failures: retry only failed events, but retry the whole batch after 5xx, reusing idempotency keys. Do not retry too many event names until a slot is freed (1,000 unique names per app).

Create Inbox Broadcast

Broadcast a message to users' OneSignal inboxes. Messages expire after seven days. Target using segments, filters, or specific user aliases. Requires the app's API key; a 403 may also indicate a nonexistent app_id.

Create Journey

Create a draft OneSignal Journey using the beta Journeys API. Requires an App API key permitted to create Journeys and an app with Journeys enabled. Only name is required in the body. Returns the full draft definition and concurrency token. Creation does not activate the Journey.

Create or Update Alias

Add or update aliases on an existing OneSignal user using an App API key. Updates identity only; does not create users or modify Subscriptions or tags. Existing labels are updated and omitted aliases remain unchanged. An alias claimed by another user returns 409 without changing either user; this does not merge users or move aliases. Use Transfer Subscription to move a Subscription.

Create or Update OneSignal User

Tool to create a new user or modify the subscriptions associated with an existing user. Use when you need to register a user with OneSignal or update their subscriptions.

Create Segment

Create an audience segment using user-property filters and AND/OR logic. Requires the app's API key. Created segments are available in the dashboard, messages, Journeys, and in-app messaging. Custom event filters are unsupported.

Create Subscription

Attach an email, SMS or push subscription to an existing user using an App API key. Identify the user by external_id, onesignal_id or a custom alias. If the type and token already exist in the app, that subscription is transferred to this user. To create a new user with subscriptions, use Create User instead.

Create Template

Create a reusable push, email, or SMS template in a OneSignal app. Requires an App API key and a configured target channel. Push and SMS need contents.en; email needs isEmail=true, email_subject and email_body. SMS needs isSMS=true. Use the returned ID as template_id when sending messages.

Delete Segment

Permanently delete a OneSignal segment without deleting users or subscriptions. Requires the app's App API key. Deleted segments cannot be recovered; recreating one requires its original filters.

Delete Subscription

Delete a single OneSignal subscription using the app's App API key. Deletion is asynchronous and stops messages to this subscription, but does not prevent a new subscription with the same token. If this is the user's last subscription, a user without an External ID or aliases is also deleted.

Delete Template

Permanently delete a message template from a OneSignal app. Requires the app's App API key from connection metadata. Deletion is immediate and irreversible. Templates used in Journeys must be removed from those Journeys before deletion.

Delete User

Permanently delete a OneSignal user using the app's App API key. Deletion is asynchronous: all associated subscriptions, properties, and identity aliases are deleted shortly after the request is accepted.

Delete User Alias

Tool to remove an alias from a OneSignal user. Use when you need to delete a specific alias identifier from a user while preserving other aliases. The user is identified by one alias (alias_label/alias_id) and a different alias (alias_label_to_delete) is removed.

Duplicate Journey

Copy an existing OneSignal Journey into a new draft using the beta Journeys API. Requires an App API key permitted to create Journeys and Journeys enabled for the app. The source is unchanged. Optional overrides use JSON Merge Patch: objects merge, null clears nullable values, and arrays replace as a unit. The provider copies supported fields; goals, A/B tests, stats, and the source schedule are not inherited. The copy is always a draft and is not activated. Returns full Journey detail and its new concurrency token.

Edit OneSignal Device

Tool to update an existing OneSignal device (player) record. Use when you have the player_id and need to modify device attributes.

Estimate RecipientsReads only

Estimate recipient counts for segment-based targeting without creating or sending a notification. Optional filters, aliases, exclusions, and channel narrow the base audience; results include plan-cap effects.

Export Audience ActivityReads only

Start a compressed CSV export of a push, email, or SMS message's audience delivery and engagement events. Returns the export URL without polling or downloading it. Only one concurrent export is allowed per OneSignal account; download the previous export before starting another.

Export Subscriptions CSVReads only

Request an asynchronous GZip CSV export of subscription data and return its URL without downloading or polling. Optionally filter by segment or recent activity and select extra columns. The URL may return 404 until generation completes and expires after 3 days. Only one export per OneSignal account can run at a time.

Get Email Provider MetricsReads only

Get email delivery and engagement counts by inbox provider for a sending domain. For customers using OneSignal Email. Reports sent, delivered, total and unique opens and clicks, failures, bounces, and spam complaints over the requested window. Start must be before end and no more than 365 days ago. A successful response can contain an empty providers list when the domain is not found for the app or is not currently active for sending. Requires an App API key (Authorization: Key <app key>) from connection metadata.

Get Email Provider Metrics TimeseriesReads only

Get email delivery and engagement counts for a sending domain over time. For customers using OneSignal Email. Buckets counts by hour, day, or month, totaled across the selected inbox providers (all providers when omitted). Returns empty events for a domain not found for the app or inactive for sending. Start must precede end and be within 365 days, or 60 days for hourly buckets. Requires an App API key (Authorization: Key <app key>) from connection metadata.

Get Email Reputation StatisticsReads only

Read email bounce and spam complaint rates for a OneSignal app. For customers using OneSignal Email. Returns the last 24 hours, 7 days, and 30 days; rates are fractions of successfully delivered emails, not percentages. Both rates are zero for windows with no successful email deliveries. Requires an App API key (Authorization: Key <app key>) from connection metadata.

List Audit LogsReads only

Retrieve one time-scoped page of organization audit log events. Requires an Enterprise plan with the audit logs entitlement enabled and an Organization API key (Authorization: Key <organization key>) supplied by connection metadata; App API keys are not accepted. Results are chronological ascending. Provide start_time for the first page (90-day maximum lookback, data available from 2026-02-18 onward), then reuse next_cursor unchanged. Cursor requests ignore time bounds. App filters still include org-level events. No automatic pagination or retries are performed.

Message HistoryReads only

Request an asynchronous export of subscriptions sent or clicking a push notification or email within seven days of sending. Requires a Professional or Enterprise plan and Send History via OneSignal API enabled before sending. Returns the accepted job result and destination URL without polling or downloading the report.

Send Email

Send an email through OneSignal to aliases, subscriptions, addresses, segments, or filters. Requires completed email setup. An empty response id means no message was sent; inspect errors.

Send Push Notification

Send a push notification to selected OneSignal users or subscriptions. A successful HTTP response with an empty id means no message was dispatched; inspect errors.

Send SMS

Send an SMS or MMS using OneSignal. Requires completed SMS setup and an App API key. An empty response id means no message was sent; inspect errors and warnings.

Start Live Activity

Remotely start an iOS Live Activity. Requires iOS 17.2+, OneSignal iOS SDK 5.2.0+, an exact activity_type match, and an audience targeting parameter to reach recipients.

Transfer Subscription

Transfer a push, email, or SMS subscription to another user in the same app. Use an App API key. OneSignal recommends SDK login instead where possible; ensure your app or website sets the same External ID. Cross-app transfers are not supported and push platform limitations may apply.

Unsubscribe Email With Token

Unsubscribe an email subscription using a token from a custom unsubscribe page. Sets the associated email subscription's enabled property to false, preventing future emails unless resubscribed or explicitly overridden. Only email subscriptions are supported. No API-key authentication or request body is required; the token identifies the subscription.

Update App

Update an existing OneSignal app's name or push platform configuration. Requires an Organization API key (Authorization: Key <organization key>), not an app REST API key, supplied through connection metadata. When setting organization_id, the key must belong to that organization. Email and SMS configuration is available only through the OneSignal dashboard.

Update Journey

Partially update a draft OneSignal Journey using JSON Merge Patch. This owner-shaped subset deliberately edits drafts only: a GET verifies draft state before PATCH. It cannot activate, schedule, archive, or edit active graphs. Requires an App API key permitted to update Journeys. Omitted fields remain unchanged and explicit null clears nullable fields, including nested rules. Sending nodes replaces the full graph, only on drafts; preserve existing node and branch IDs from a prior fetch. Returns full Journey detail. Pass the prior concurrency_key unchanged to detect concurrent edits (409 journey-stale).

Update Journey Node

Partially update one node of a draft OneSignal Journey (beta). Requires an App API key permitted to update Journeys. Fetches the parent and refuses to PATCH unless its server state is draft. Send only changed node fields; null clears a nullable field and arrays replace in full. The addressed node's kind and id are immutable. Returns the full updated Journey. Pass the prior View Journey concurrency_key unchanged to detect concurrent edits.

Update Live Activity

Update or end a running iOS Live Activity on every device registered under its topic key. Ending is irreversible: later requests to the same activity_id have no effect.

Update Message State

Update the read, opened, or deleted state of one user's inbox message. Each flag can be changed independently; omitted or null flags are unchanged. Requires the app's App API key. A 403 can also indicate a nonexistent app_id; an unknown alias label or missing user can produce a 404.

Update Segment

Update a OneSignal segment using an App API key. The name is always required. Supplied filters replace all existing filters; omit filters to retain them. Availability depends on the app's plan.

Update Subscription

Update an existing OneSignal subscription by its immutable subscription ID. Updates are asynchronous and may take a few seconds. The subscription type cannot be changed; delete and recreate the subscription to correct its type.

Update Subscription By Token

Tool to update properties on an existing subscription using its token. Use when you need to enable or disable subscription status when managing outside of the OneSignal SDK.

Update Template

Update an existing push, email, or SMS message template. Requires an App API key (Authorization: Key <app key>) from connection metadata. Changes apply immediately to dashboard and API template references. Push contents need en text; email templates require isEmail=true, email_body, and an email subject configured on the template. SMS templates use isSMS=true.

Update User

Update an existing OneSignal user's profile properties using an App API key. Locate the user by external_id, onesignal_id, or a custom alias. Use the alias APIs to change identity and the subscription APIs to manage subscriptions. A 202 response means the update was accepted.

View API KeysReads only

List metadata for all current API keys belonging to a OneSignal app. Requires an Organization API key (Authorization: Key <organization key>) from connection metadata. Returns token IDs, names, IP allowlists and timestamps. Does not return API key secrets; formatted_token is never populated by this endpoint.

View AppReads only

Tool to retrieve details for a specific OneSignal app. Use after authenticating to inspect app settings.

View AppsReads only

List OneSignal apps with metadata, subscription counts and platform configuration. Requires an Organization API key (not an app REST API key). App API keys, conversion attribution windows and channels are not returned. Accounts or organizations with more than 1000 apps receive HTTP 400, not a truncated list.

View BroadcastsReads only

Tool to view inbox broadcasts for a OneSignal app. Returns broadcasts in descending order of creation. Use when retrieving in-app messages or inbox content for an app.

View Identity By SubscriptionReads only

Retrieve all aliases for a OneSignal user by subscription using an App API key. Look up the user using a known push, email, or SMS subscription ID. Returns identity only, without subscriptions or properties.

View JourneyReads only

Retrieve a journey's full audience, schedule, lifecycle rules, and node graph. Beta: endpoints and response fields can still change. Requires an App API key with permission to view journeys (Authorization: Key <app key>). Find journey_id with View Journeys or in the dashboard URL. Returns node and branch IDs plus the opaque concurrency_key needed for later updates; send that token back unchanged rather than constructing or parsing it.

View Journey StatsReads only

Retrieve all-time performance stats for one Journey (Beta). Returns entry/exit counts, flat node and branch maps keyed by server IDs, and channel-specific delivery totals under each sending node's message_stats.totals. No date range or granularity filters are supported. Join IDs against View Journey for definition details. Find journey_id via View Journeys or the dashboard URL. Requires an App API key with permission to view journeys, supplied by connection metadata as Authorization: Key <app key>. Beta endpoints and response fields may change.

View JourneysReads only

List one page of Journey summaries for a OneSignal app, newest first. Beta: endpoints and response fields can still change. Requires an App API key (Authorization: Key <app key>) supplied by connection metadata, with permission to view journeys. Returns identity, state, scheduling, reentry rules, and audience kind. Use View Journey for the full configuration. Omit cursor initially, then pass next_cursor unchanged for another page; this action does not automatically paginate or retry.

View MessageReads only

Read one push, email, or SMS message and optionally its outcome metrics. Requires an App API key (Authorization: Key <app key>) from connection metadata. Journey-sent messages are unavailable. API-sent messages are accessible for 30 days after creation; dashboard messages for the app's lifetime. Supply outcome_names with .count or .sum to fetch outcomes.

View MessagesReads only

Read one bounded page of push, email, or SMS messages for a OneSignal app. Requires an App API key (Authorization: Key <app key>) from connection metadata. Excludes Journey-sent messages. API-sent messages are retained for 30 days, dashboard-sent messages for the app's lifetime. Use offset for ad-hoc paging or time_offset for ascending sequential pulls; no automatic pagination is performed. For bulk exports prefer OneSignal Event Streams.

View OneSignal DeviceReads only

Tool to retrieve details for a specific device/player. Use when you have a player_id and optional app_id.

View OneSignal SegmentReads only

Tool to retrieve the subscriber count for a specific OneSignal segment. Use when you need to know how many subscribers are in a segment.

View OneSignal UserReads only

Tool to retrieve user details by alias label and ID. Use when you need to fetch user data including tags, subscriptions, and identity information.

View OutcomesReads only

Tool to view all outcomes associated with a OneSignal app. Use to retrieve outcome metrics filtered by time range, platforms, and attribution type.

View SegmentsReads only

Tool to list all segments for an app. Use after obtaining the app_id to retrieve a paginated list of segments.

View TemplateReads only

Retrieve one push, email, or SMS message template by its template ID. Returns template content, target channel, and creation/update timestamps. Requires an App API key (Authorization: Key <app key>) from connection metadata. Find the template ID via View Templates or the dashboard's Messages > Templates > Options > Copy Template ID.

View TemplatesReads only

List one bounded page of message template summaries for a OneSignal app. Requires an App API key (Authorization: Key <app key>) from connection metadata. Returns IDs, names, and creation/update timestamps, not full template content. Use View Template for content. Adjust offset to fetch another page; this action does not automatically paginate.

View User BroadcastsReads only

Read one page of inbox broadcasts received by a OneSignal user. Includes broadcasts sent to segments or audiences the user belongs to. Requires an App API key (Authorization: Key <app key>) from connection metadata. Messages are newest first; reuse the returned last_message_id for older messages. No automatic pagination is performed.

View User IdentityReads only

Retrieve all aliases for a OneSignal user using an App API key. Look up the user by external_id, onesignal_id, or a custom alias. Returns identity only, without subscriptions or properties.

View User Unread Message CountReads only

Retrieve the unread inbox message count for a user identified by alias. The returned count defaults to zero if the response omits it.

More in Notifications

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or