Skip to main content
OneSignal REST API logo
  • Category: notifications
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 15
  • Triggers: 0
  • Slug: ONESIGNAL_REST_API
  • Version: 20261101_00

Tools

Slug: ONESIGNAL_REST_API_BEGIN_LIVE_ACTIVITYTool to start a Live Activity on OneSignal. Use when you need to initiate a Live Activity session with a push token and subscription ID.

Input Parameters

string
required
The OneSignal App ID for your app. Available in Keys & IDs.
string
required
The device’s push token for Live Activities (64-character hexadecimal string)
string
required
Live Activity record ID
string
required
The OneSignal subscription ID associated with the device

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_CREATE_NOTIFICATIONTool to create and send a OneSignal push notification. Use when you have your message and target audience ready to dispatch notifications.

Input Parameters

string
URL to open when the notification is tapped
object
Custom key/value data payload
string
required
Your OneSignal App ID
array
Action buttons; see OneSignal docs for fields (id, text, icon, url)
array
Advanced audience filters; see OneSignal docs for syntax
object
required
Notification message per language
object
Notification title per language
object
Notification subtitle per language
string
Custom iOS sound file
string
URL for Android large icon
string
Schedule delivery time in ISO 8601 format (e.g., ‘2023-09-01T12:00:00Z’)
string
URL for Android big picture
object
Additional OneSignal parameters not explicitly modeled above
string
Custom Android sound file
string ("timezone" | "last-active")
Delay delivery based on ‘timezone’ or ‘last-active’
object
iOS media attachments mapping identifiers to URLs
array
Predefined audience segments (e.g., [‘All’])
string
Android channel ID to post notification to
array
Specific device/player IDs to send the notification to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_CREATE_TEMPLATETool to create reusable message templates for push, email, and SMS channels. Use when you need to create a template that can be accessed through both the dashboard and API using a template_id.

Input Parameters

string
Associated URL for the notification
boolean
Platform targeting flag for Windows Phone (defaults to true)
string
required
Internal name for organizing and tracking templates (maximum 128 characters)
boolean
Platform targeting flag for Amazon (defaults to true)
boolean
Platform targeting flag for iOS (defaults to true)
boolean
Required to be set true for SMS templates
string
required
Your OneSignal App ID
boolean
Platform targeting flag for Microsoft Edge (defaults to true)
boolean
Required to be set true for email templates
object
The main message body with language-specific values (e.g., {‘en’: ‘Hello!’}). Applies to push and SMS templates. Supports message personalization.
object
Language-specific heading values for push notifications
boolean
Platform targeting flag for Chrome Apps (defaults to true)
boolean
Platform targeting flag for macOS (defaults to true)
boolean
Platform targeting flag for Safari (defaults to true)
boolean
Platform targeting flag for Windows Push Notification Services (defaults to true)
boolean
Platform targeting flag for Android (defaults to true)
boolean
Platform targeting flag for Firefox (defaults to true)
string
The body of the email in HTML format (required when creating email templates). Supports message personalization.
boolean
Platform targeting flag for Chrome Web Push (defaults to true)
string
The subject of the email (required when creating email templates). Supports message personalization.
object
Enables programmatic personalization without CSV uploads. Structure supports nested key-value campaign variations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_CREATE_USERCreate a OneSignal user with optional subscriptions and aliases, or modify subscriptions associated with an existing user. Supplied aliases are used to look up an existing user.

Input Parameters

string
required
Your OneSignal App ID
object
Identity object for user identification. Aliases provided will be used to look up an existing user.
object
User properties including location, activity, and custom data.
array
List of subscriptions (devices/channels) owned by the user
object
Options for subscription management.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_DELETE_ALIASTool to delete an alias by alias label from a OneSignal user. Use when you need to remove a specific alias identity from a user’s profile.

Input Parameters

string
required
The OneSignal App ID
string
required
The value of the alias to identify the user
string
required
The alias label to identify the user (e.g., ‘external_id’, ‘email’)
string
required
The alias label to delete from the user’s identity (e.g., ‘email’, ‘phone_number’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_DELETE_DEVICETool to delete a device (player) from a OneSignal app. Use when you need to remove a specific device by its player ID.

Input Parameters

string
required
The OneSignal App ID
string
required
The OneSignal Player (Device) ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_FETCH_USER_IDENTITYTool to retrieve all aliases for a user identified by a specific alias. Use when you need to fetch the complete identity mapping for a OneSignal user.

Input Parameters

string
required
Your OneSignal App ID.
string
required
The alias value/ID to identify the user (e.g., ‘test-user-123’, ‘user@example.com’).
string
required
The alias label to identify the user (e.g., ‘external_id’, ‘email’, ‘phone_number’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_GET_ELIGIBLE_IAMSTool to retrieve the manifest of In-App Messages that a subscription is eligible to display. Use when you need to fetch eligible IAMs for a specific subscription.

Input Parameters

string
required
Unique identifier for the OneSignal app.
string
required
Unique identifier for the subscription (device/player).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_UPDATE_DEVICETool to update properties of an existing device. Use when you need to modify device attributes after registration.

Input Parameters

object
Custom tags for the device
string
Advertising ID
string
required
Your OneSignal App ID
string
Country code, e.g., ‘US’
string
Language code, e.g., ‘en’
number
Latitude coordinate
integer
Total playtime in seconds
integer
Timezone offset in seconds from UTC
string
Operating system version
number
Longitude coordinate
string
required
Unique OneSignal device/player ID
integer
1 for development, 2 for ad-hoc
integer
Unix timestamp when the device was created
string
Push token, email address, or external user ID
integer
iOS badge count
integer
Device type. See OneSignal docs for list
integer
Unix timestamp when the device was last active
string
Amount the user has spent
string
Device model
string
Version of the app/game
string
SMS authentication hash
string
Email authentication hash
string
External user ID
object
Additional custom attributes
integer
Notification permission state
string
Auth hash for external_user_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_UPDATE_SUBSCRIPTIONTool to update an existing subscription’s properties. Use when you need to modify subscription attributes like token, enabled status, or device information.

Input Parameters

string
required
Your OneSignal App ID.
object
required
The subscription properties to update.
string
required
The unique ID of the subscription to update.
boolean
Whether to retain the previous owner when updating the subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_VIEW_AN_APPTool to retrieve metadata for a single OneSignal app. Use when you need to fetch app details by its ID.

Input Parameters

string
required
Unique identifier for the OneSignal app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_VIEW_DEVICETool to retrieve details of a specific device (player). Use when you have a OneSignal player_id and need current device info.

Input Parameters

string
required
Your OneSignal App ID.
string
required
Unique ID of the device (player) to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_VIEW_DEVICESTool 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.

Input Parameters

integer
Maximum number of devices to return (1-300). Defaults to 300.
string
required
Your OneSignal App ID.
integer
Pagination offset. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_VIEW_NOTIFICATIONSTool to retrieve details of multiple notifications. Use when you need to list notifications for a specific app.

Input Parameters

integer
Maximum number of notifications to return (1-300). Defaults to 50.
string
required
Your OneSignal App ID.
integer
Result offset for pagination. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONESIGNAL_REST_API_VIEW_SEGMENTSList segments associated with a OneSignal app, using limit and offset to page through results.

Input Parameters

integer
Maximum number of segments to return (1-300). Default is 50.
string
required
OneSignal App ID to list segments for
integer
Zero-based offset for pagination. Results sorted by creation time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not