> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# OneSignal REST API

> The OneSignal REST API enables developers to programmatically send push notifications, emails, and SMS, manage users and subscriptions, and configure apps.

![OneSignal REST API logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/onesignal_rest_api.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=3ea4ea8a3881ed44e8afd4615ac185e0)

* **Category:** notifications
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 15
* **Triggers:** 0
* **Slug:** `ONESIGNAL_REST_API`
* **Version:** 20261101\_00

## Tools

> [accordion] Begin Live Activity
>
> **Slug:** `ONESIGNAL_REST_API_BEGIN_LIVE_ACTIVITY`
>
> Tool 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
>
> **app\_id** `string` *required*
>
> The OneSignal App ID for your app. Available in Keys & IDs.
>
> **push\_token** `string` *required*
>
> The device's push token for Live Activities (64-character hexadecimal string)
>
> **activity\_id** `string` *required*
>
> Live Activity record ID
>
> **subscription\_id** `string` *required*
>
> The OneSignal subscription ID associated with the device
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Notification
>
> **Slug:** `ONESIGNAL_REST_API_CREATE_NOTIFICATION`
>
> Tool to create and send a OneSignal push notification. Use when you have your message and target audience ready to dispatch notifications.
>
> #### Input Parameters
>
> **url** `string`
>
> URL to open when the notification is tapped
>
> **data** `object`
>
> Custom key/value data payload
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID
>
> **buttons** `array`
>
> Action buttons; see OneSignal docs for fields (id, text, icon, url)
>
> **filters** `array`
>
> Advanced audience filters; see OneSignal docs for syntax
>
> **contents** `object` *required*
>
> Notification message per language
>
> **headings** `object`
>
> Notification title per language
>
> **subtitle** `object`
>
> Notification subtitle per language
>
> **ios\_sound** `string`
>
> Custom iOS sound file
>
> **large\_icon** `string`
>
> URL for Android large icon
>
> **send\_after** `string`
>
> Schedule delivery time in ISO 8601 format (e.g., '2023-09-01T12:00:00Z')
>
> **big\_picture** `string`
>
> URL for Android big picture
>
> **extra\_params** `object`
>
> Additional OneSignal parameters not explicitly modeled above
>
> **android\_sound** `string`
>
> Custom Android sound file
>
> **delayed\_option** `string ("timezone" | "last-active")`
>
> Delay delivery based on 'timezone' or 'last-active'
>
> **ios\_attachments** `object`
>
> iOS media attachments mapping identifiers to URLs
>
> **included\_segments** `array`
>
> Predefined audience segments (e.g., \['All'])
>
> **android\_channel\_id** `string`
>
> Android channel ID to post notification to
>
> **include\_player\_ids** `array`
>
> Specific device/player IDs to send the notification to
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Template
>
> **Slug:** `ONESIGNAL_REST_API_CREATE_TEMPLATE`
>
> Tool 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
>
> **url** `string`
>
> Associated URL for the notification
>
> **isWP** `boolean`
>
> Platform targeting flag for Windows Phone (defaults to true)
>
> **name** `string` *required*
>
> Internal name for organizing and tracking templates (maximum 128 characters)
>
> **isAdm** `boolean`
>
> Platform targeting flag for Amazon (defaults to true)
>
> **isIos** `boolean`
>
> Platform targeting flag for iOS (defaults to true)
>
> **isSMS** `boolean`
>
> Required to be set true for SMS templates
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID
>
> **isEdge** `boolean`
>
> Platform targeting flag for Microsoft Edge (defaults to true)
>
> **isEmail** `boolean`
>
> Required to be set true for email templates
>
> **contents** `object`
>
> The main message body with language-specific values (e.g., \{'en': 'Hello!'}). Applies to push and SMS templates. Supports message personalization.
>
> **headings** `object`
>
> Language-specific heading values for push notifications
>
> **isChrome** `boolean`
>
> Platform targeting flag for Chrome Apps (defaults to true)
>
> **isMacOSX** `boolean`
>
> Platform targeting flag for macOS (defaults to true)
>
> **isSafari** `boolean`
>
> Platform targeting flag for Safari (defaults to true)
>
> **isWP\_WNS** `boolean`
>
> Platform targeting flag for Windows Push Notification Services (defaults to true)
>
> **isAndroid** `boolean`
>
> Platform targeting flag for Android (defaults to true)
>
> **isFirefox** `boolean`
>
> Platform targeting flag for Firefox (defaults to true)
>
> **email\_body** `string`
>
> The body of the email in HTML format (required when creating email templates). Supports message personalization.
>
> **isChromeWeb** `boolean`
>
> Platform targeting flag for Chrome Web Push (defaults to true)
>
> **email\_subject** `string`
>
> The subject of the email (required when creating email templates). Supports message personalization.
>
> **dynamic\_content** `object`
>
> Enables programmatic personalization without CSV uploads. Structure supports nested key-value campaign variations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create User
>
> **Slug:** `ONESIGNAL_REST_API_CREATE_USER`
>
> Create 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
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID
>
> **identity** `object`
>
> Identity object for user identification. Aliases provided will be used to look up an existing user.
>
> **properties** `object`
>
> User properties including location, activity, and custom data.
>
> **subscriptions** `array`
>
> List of subscriptions (devices/channels) owned by the user
>
> **subscription\_options** `object`
>
> Options for subscription management.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Alias
>
> **Slug:** `ONESIGNAL_REST_API_DELETE_ALIAS`
>
> Tool 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
>
> **app\_id** `string` *required*
>
> The OneSignal App ID
>
> **alias\_id** `string` *required*
>
> The value of the alias to identify the user
>
> **alias\_label** `string` *required*
>
> The alias label to identify the user (e.g., 'external\_id', 'email')
>
> **alias\_label\_to\_delete** `string` *required*
>
> The alias label to delete from the user's identity (e.g., 'email', 'phone\_number')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Device
>
> **Slug:** `ONESIGNAL_REST_API_DELETE_DEVICE`
>
> Tool to delete a device (player) from a OneSignal app. Use when you need to remove a specific device by its player ID.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> The OneSignal App ID
>
> **player\_id** `string` *required*
>
> The OneSignal Player (Device) ID to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch User Identity
>
> **Slug:** `ONESIGNAL_REST_API_FETCH_USER_IDENTITY`
>
> Tool 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
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID.
>
> **alias\_id** `string` *required*
>
> The alias value/ID to identify the user (e.g., 'test-user-123', '[user@example.com](mailto:user@example.com)').
>
> **alias\_label** `string` *required*
>
> The alias label to identify the user (e.g., 'external\_id', 'email', 'phone\_number').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Eligible In-App Messages
>
> **Slug:** `ONESIGNAL_REST_API_GET_ELIGIBLE_IAMS`
>
> Tool 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
>
> **app\_id** `string` *required*
>
> Unique identifier for the OneSignal app.
>
> **subscription\_id** `string` *required*
>
> Unique identifier for the subscription (device/player).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Device
>
> **Slug:** `ONESIGNAL_REST_API_UPDATE_DEVICE`
>
> Tool to update properties of an existing device. Use when you need to modify device attributes after registration.
>
> #### Input Parameters
>
> **tags** `object`
>
> Custom tags for the device
>
> **ad\_id** `string`
>
> Advertising ID
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID
>
> **country** `string`
>
> Country code, e.g., 'US'
>
> **language** `string`
>
> Language code, e.g., 'en'
>
> **latitude** `number`
>
> Latitude coordinate
>
> **playtime** `integer`
>
> Total playtime in seconds
>
> **timezone** `integer`
>
> Timezone offset in seconds from UTC
>
> **device\_os** `string`
>
> Operating system version
>
> **longitude** `number`
>
> Longitude coordinate
>
> **player\_id** `string` *required*
>
> Unique OneSignal device/player ID
>
> **test\_type** `integer`
>
> 1 for development, 2 for ad-hoc
>
> **created\_at** `integer`
>
> Unix timestamp when the device was created
>
> **identifier** `string`
>
> Push token, email address, or external user ID
>
> **badge\_count** `integer`
>
> iOS badge count
>
> **device\_type** `integer`
>
> Device type. See OneSignal docs for list
>
> **last\_active** `integer`
>
> Unix timestamp when the device was last active
>
> **amount\_spent** `string`
>
> Amount the user has spent
>
> **device\_model** `string`
>
> Device model
>
> **game\_version** `string`
>
> Version of the app/game
>
> **sms\_auth\_hash** `string`
>
> SMS authentication hash
>
> **email\_auth\_hash** `string`
>
> Email authentication hash
>
> **external\_user\_id** `string`
>
> External user ID
>
> **custom\_attributes** `object`
>
> Additional custom attributes
>
> **notification\_types** `integer`
>
> Notification permission state
>
> **external\_user\_id\_auth\_hash** `string`
>
> Auth hash for external\_user\_id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Subscription
>
> **Slug:** `ONESIGNAL_REST_API_UPDATE_SUBSCRIPTION`
>
> Tool to update an existing subscription's properties. Use when you need to modify subscription attributes like token, enabled status, or device information.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID.
>
> **subscription** `object` *required*
>
> The subscription properties to update.
>
> **subscription\_id** `string` *required*
>
> The unique ID of the subscription to update.
>
> **retain\_previous\_owner** `boolean`
>
> Whether to retain the previous owner when updating the subscription.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] View OneSignal App
>
> **Slug:** `ONESIGNAL_REST_API_VIEW_AN_APP`
>
> Tool to retrieve metadata for a single OneSignal app. Use when you need to fetch app details by its ID.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> Unique identifier for the OneSignal app.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] View Device
>
> **Slug:** `ONESIGNAL_REST_API_VIEW_DEVICE`
>
> Tool to retrieve details of a specific device (player). Use when you have a OneSignal player\_id and need current device info.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID.
>
> **player\_id** `string` *required*
>
> Unique ID of the device (player) to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] View Devices
>
> **Slug:** `ONESIGNAL_REST_API_VIEW_DEVICES`
>
> Tool 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
>
> **limit** `integer`
>
> Maximum number of devices to return (1-300). Defaults to 300.
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID.
>
> **offset** `integer`
>
> Pagination offset. Defaults to 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] View Notifications
>
> **Slug:** `ONESIGNAL_REST_API_VIEW_NOTIFICATIONS`
>
> Tool to retrieve details of multiple notifications. Use when you need to list notifications for a specific app.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of notifications to return (1-300). Defaults to 50.
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID.
>
> **offset** `integer`
>
> Result offset for pagination. Defaults to 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] View Segments
>
> **Slug:** `ONESIGNAL_REST_API_VIEW_SEGMENTS`
>
> List segments associated with a OneSignal app, using limit and offset to page through results.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of segments to return (1-300). Default is 50.
>
> **app\_id** `string` *required*
>
> OneSignal App ID to list segments for
>
> **offset** `integer`
>
> Zero-based offset for pagination. Results sorted by creation time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
