OneSignal

Retrieve the details of every app API key (Rich Authentication Token) registered against a OneSignal app.

Create a new app API key (Rich Authentication Token) for a OneSignal app, optionally restricted to an IP allowlist.

Rename an existing app API key or change its IP allowlist settings, leaving its secret value unchanged.

Permanently revoke one app API key so it can no longer authenticate requests.

Issue a new secret for an existing app API key while keeping its token_id, name and IP allowlist unchanged.

Retrieve every OneSignal app belonging to the organization behind the Organization API Key.

Retrieve the full metadata and push platform configuration of the configured OneSignal app.

Create a new OneSignal app, optionally configuring its Web, Android and iOS push credentials in the same call.

Update the name or the Web, Android and iOS push platform configuration of the configured OneSignal app.

Retrieve a paginated, time-scoped list of audit log events for a OneSignal organization.

Record one or more custom events for OneSignal users to feed Journey triggers and analytics.

Start an asynchronous background job that generates a GZip-compressed CSV of the app’s subscription records and returns…

Start an asynchronous background job that generates a compressed CSV of per-recipient delivery and engagement events for…

Retrieve the inbox broadcasts sent to an app’s audience, each with its delivery stats.

Broadcast a message into the in-app inbox of the app’s users.

Retrieve a paginated list of journeys configured for a OneSignal app.

Retrieve the full configuration of a single journey by its UUID.

Retrieve entry, exit, node and branch level performance counters for a single journey.

Create a new journey in draft state with an audience, optional scheduling and an initial node graph.

Apply a full or partial update to a journey’s top-level fields, including its state and node graph.

Permanently delete a journey by its UUID.

Apply a JSON Merge Patch to a single node inside a journey’s node graph.

Remotely start an iOS Live Activity on targeted devices.

Push a content update to a running iOS Live Activity, or end it.

Retrieve a collection of messages previously sent or scheduled for a OneSignal app.

Retrieve the details of a single message together with the outcomes recorded against it.

Stop a scheduled or currently outgoing message.

Request a report of which subscriptions were sent or clicked a particular message.

Return the estimated recipient count for a set of targeting criteria without creating or sending a message.

Disable the email subscription tied to a sent message using its unsubscribe token.

Send or schedule a push notification to app and web subscribers of a OneSignal app.

Send or schedule an email to the email subscriptions of a OneSignal app.

Send or schedule an SMS or MMS message to the phone numbers of a OneSignal app.

Retrieve aggregated outcome metrics attributed back to the messages that drove them.

Retrieve the segments configured for a OneSignal app.

Retrieve a single segment’s subscriber count and, optionally, its metadata and filter definition.

Create a saved audience segment in a OneSignal app from a chain of tag, activity and location filters.

Rename a segment and optionally replace its entire filter definition.

Permanently delete a segment definition from a OneSignal app.

Retrieve every alias bound to the user who owns a given OneSignal subscription.

Attach a new push, email or SMS subscription to an existing OneSignal user identified by an alias.

Create or update aliases on the user who owns a given OneSignal subscription.

Update the properties of an existing OneSignal subscription addressed by its subscription ID.

Update the properties of an existing OneSignal subscription addressed by its raw channel token.

Move an existing OneSignal subscription to a different user within the same app.

Permanently delete a OneSignal subscription by its subscription ID.

Retrieve a paginated list of message templates configured for the OneSignal app.

Retrieve the full details of a single message template by its template ID.

Create a reusable push, email or SMS message template on the OneSignal app.

Update the name or channel content of an existing message template.

Permanently delete a message template from the OneSignal app by its template ID.

Duplicate a message template into another app in the same OneSignal organization.

List the in-app inbox broadcasts delivered to a single OneSignal user, located by an alias pair.

Retrieve the number of unread in-app inbox messages for a single OneSignal user.

Update the read, opened or deleted state of one specific in-app inbox message for a OneSignal user.

Update the read, opened or deleted state of many of a user’s in-app inbox messages at once, across a range bounded by la…

Retrieve a single OneSignal user, including aliases, properties and subscriptions, by a known alias pair.

Retrieve every alias attached to a OneSignal user, located by any one known alias pair.

Create a OneSignal user with its identity, profile properties and channel subscriptions.

Add or update one or more aliases on a OneSignal user located by a known alias pair.

Modify the properties of a OneSignal user, or apply incremental deltas, using a known alias pair.

Permanently delete a OneSignal user, with all of its properties, aliases and subscriptions, by alias pair.

Remove one alias label from a OneSignal user, located by a known alias pair, keeping the user intact.