63 actions

Action

Description

View API Keys

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

Create API Key

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

Update API Key

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

Delete API Key

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

Rotate API Key

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

View Apps

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

View An App

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

Create An App

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

Update An App

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

List Audit Logs

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

Create Custom Events

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

Export Subscriptions CSV

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

Export Audience Activity CSV

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

View Broadcasts

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

Create Inbox Broadcast Message

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

View Journeys

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

View Journey

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

View Journey Stats

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

Create Journey

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

Update Journey

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

Delete Journey

Permanently delete a journey by its UUID.

Update Journey Node

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

Start Live Activity

Remotely start an iOS Live Activity on targeted devices.

Update Live Activity

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

View Messages

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

View Message

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

Cancel Message

Stop a scheduled or currently outgoing message.

Get Message History

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

Estimate Notification Recipients

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

Unsubscribe Email (With Token)

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

Create Push Notification

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

Create Email Message

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

Create SMS Message

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

View Outcomes

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

View Segments

Retrieve the segments configured for a OneSignal app.

View Segment

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

Create Segment

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

Update Segment

Rename a segment and optionally replace its entire filter definition.

Delete Segment

Permanently delete a segment definition from a OneSignal app.

View User Identity (By Subscription)

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

Create Subscription By Alias

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

Create Alias (By Subscription)

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

Update Subscription

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

Update Subscription By Token

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

Transfer Subscription

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

Delete Subscription

Permanently delete a OneSignal subscription by its subscription ID.

View Templates

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

View Template

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

Create Template

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

Update Template

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

Delete Template

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

Copy Template To Another App

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

View User Broadcasts

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

View User Unread Message Count

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

Update Message State

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

Bulk Update Or Delete Message State

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...

View User

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

View User Identity

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

Create User

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

Create Or Update Alias

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

Update User

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

Delete User

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

Delete Alias

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