> ## 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 User Auth

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

![OneSignal User Auth logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/onesignal_user_auth.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=ad182b04a2c25352766bbbe3dd8f8caa)

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

## Tools

> [accordion] Create or Update OneSignal User
>
> **Slug:** `ONESIGNAL_USER_AUTH_CREATE_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.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID in UUID v4 format.
>
> **identity** `object` *required*
>
> Defines identifiers for the user. The external\_id must be used and should be unique across users.
>
> **properties** `object`
>
> User profile data including tags, preferences, and other properties.
>
> **subscriptions** `array`
>
> The subscriptions object allows for creating or transferring subscriptions to a specified user.
>
> #### 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 User Alias
>
> **Slug:** `ONESIGNAL_USER_AUTH_DELETE_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.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID in UUID v4 format. See Keys & IDs documentation.
>
> **alias\_id** `string` *required*
>
> The specific identifier for the given alias to identify the user.
>
> **alias\_label** `string`
>
> The alias name or key to locate the user. Most commonly set as 'external\_id' but can be the 'onesignal\_id' or a custom alias.
>
> **alias\_label\_to\_delete** `string` *required*
>
> The name of the alias to remove from the user.
>
> #### 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] Edit OneSignal Device
>
> **Slug:** `ONESIGNAL_USER_AUTH_EDIT_DEVICE`
>
> Tool to update an existing OneSignal device (player) record. Use when you have the player\_id and need to modify device attributes.
>
> #### Input Parameters
>
> **lat** `number`
>
> Device latitude.
>
> **sdk** `string`
>
> Version of the OneSignal SDK.
>
> **long** `number`
>
> Device longitude.
>
> **tags** `object`
>
> Custom tags to set on the device.
>
> **ad\_id** `string`
>
> Advertising identifier (IDFA or AAID).
>
> **app\_id** `string`
>
> OneSignal App ID the device belongs to.
>
> **country** `string`
>
> Country code (e.g., 'US').
>
> **language** `string`
>
> Locale code of the device (ISO 639-1).
>
> **playtime** `integer`
>
> Seconds the player has been online.
>
> **timezone** `integer`
>
> Offset in seconds from UTC (negative if behind).
>
> **device\_os** `string`
>
> Operating system version of the device.
>
> **player\_id** `string` *required*
>
> Unique device (player) ID to update.
>
> **created\_at** `integer`
>
> Unix timestamp when the device was created.
>
> **identifier** `string`
>
> Push token (e.g., FCM or APNS token) or email.
>
> **badge\_count** `integer`
>
> Current iOS badge count displayed on the app icon.
>
> **last\_active** `integer`
>
> Last active time as a Unix timestamp.
>
> **amount\_spent** `number`
>
> Total amount spent by the user.
>
> **device\_model** `string`
>
> Hardware model of the device.
>
> **game\_version** `string`
>
> App version of the device.
>
> **session\_count** `integer`
>
> Number of times the app has been opened.
>
> **notification\_types** `integer`
>
> 1 = subscribed, -2 = unsubscribed (iOS only).
>
> #### 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 Segment
>
> **Slug:** `ONESIGNAL_USER_AUTH_ONESIGNAL_VIEW_SEGMENT`
>
> Tool to retrieve the subscriber count for a specific OneSignal segment. Use when you need to know how many subscribers are in a segment.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> The OneSignal App ID to retrieve segment for.
>
> **segment\_id** `string` *required*
>
> The OneSignal Segment ID to retrieve details for.
>
> #### 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 By Token
>
> **Slug:** `ONESIGNAL_USER_AUTH_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.
>
> #### Input Parameters
>
> **token** `string` *required*
>
> The push token, email address, or phone number associated with the subscription. Format must match the token\_type (e.g., valid email for Email type, E.164 format for SMS, 64-char hex for iOS).
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID in UUID v4 format.
>
> **token\_type** `string ("Email" | "SMS" | "iOSPush" | "AndroidPush" | "HuaweiPush" | "FireOSPush" | "WindowsPush" | "macOSPush" | "ChromeExtensionPush" | "ChromePush" | "FirefoxPush" | "SafariPush")` *required*
>
> The subscription channel type. Must match the format of the token.
>
> **subscription** `object` *required*
>
> The subscription properties to update.
>
> #### 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 App
>
> **Slug:** `ONESIGNAL_USER_AUTH_VIEW_APP`
>
> Tool to retrieve details for a specific OneSignal app. Use after authenticating to inspect app settings.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> The OneSignal App ID to retrieve details for.
>
> #### 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 Broadcasts
>
> **Slug:** `ONESIGNAL_USER_AUTH_VIEW_BROADCASTS`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The number of broadcasts to retrieve. Defaults to OneSignal default if omitted.
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID in UUID v4 format. See Keys & IDs.
>
> **last\_broadcast\_id** `string`
>
> The exclusive lower bound of broadcasts to retrieve. Pass in successive requests to page through results.
>
> #### 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 Device
>
> **Slug:** `ONESIGNAL_USER_AUTH_VIEW_DEVICE`
>
> Tool to retrieve details for a specific device/player. Use when you have a player\_id and optional app\_id.
>
> #### Input Parameters
>
> **app\_id** `string`
>
> OneSignal App ID to scope the lookup. If omitted, uses the default app from authentication.
>
> **player\_id** `string` *required*
>
> The OneSignal Player (device) ID to retrieve details for.
>
> #### 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 Outcomes
>
> **Slug:** `ONESIGNAL_USER_AUTH_VIEW_OUTCOMES`
>
> Tool to view all outcomes associated with a OneSignal app. Use to retrieve outcome metrics filtered by time range, platforms, and attribution type.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> OneSignal App ID in UUID v4 format to retrieve outcomes for.
>
> **outcome\_names** `array`
>
> List of outcome names with aggregation type to fetch. Format: 'outcome\_name.aggregation\_type' (e.g., 'my\_outcome.count' or 'my\_outcome.sum'). For clicks use 'os\_\_click.count', for confirmed deliveries use 'os\_\_confirmed\_delivery.count', for session duration use 'os\_\_session\_duration.count'.
>
> **outcome\_platforms** `string`
>
> Comma-separated list of platform device\_type integers to include. Defaults to '0,1,2,5,8,11,14,17' if not specified.
>
> **outcome\_time\_range** `string ("1h" | "1d" | "1mo")`
>
> Time range for outcome data.
>
> **outcome\_attribution** `string ("direct" | "influenced" | "unattributed" | "total")`
>
> Attribution type for outcomes.
>
> #### 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_USER_AUTH_VIEW_SEGMENTS`
>
> Tool to list all segments for an app. Use after obtaining the app\_id to retrieve a paginated list of segments.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of segments to return (1 to 300). Defaults to OneSignal default if omitted.
>
> **app\_id** `string` *required*
>
> OneSignal App ID to list segments for
>
> **offset** `integer`
>
> Offset for pagination (number of items to skip).
>
> #### 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 User
>
> **Slug:** `ONESIGNAL_USER_AUTH_VIEW_USER`
>
> Tool to retrieve user details by alias label and ID. Use when you need to fetch user data including tags, subscriptions, and identity information.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID in UUID v4 format. See Keys & IDs.
>
> **alias\_id** `string` *required*
>
> The specific identifier for the given alias to identify the user.
>
> **alias\_label** `string` *required*
>
> The alias name or key to locate the user. Most commonly set as `external_id` but can be the `onesignal_id` or a custom alias. See Aliases.
>
> #### 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 User Unread Message Count
>
> **Slug:** `ONESIGNAL_USER_AUTH_VIEW_USER_UNREAD_MESSAGE_COUNT`
>
> Retrieve the unread inbox message count for a user identified by alias. The returned count defaults to zero if the response omits it.
>
> #### Input Parameters
>
> **app\_id** `string` *required*
>
> Your OneSignal App ID in UUID v4 format. See Keys & IDs.
>
> **alias\_id** `string` *required*
>
> The identifier or value set for the desired alias label.
>
> **alias\_label** `string` *required*
>
> The alias name or key to locate the user. Most commonly set as `external_id` but can be the `onesignal_id` or a custom alias.
>
> #### 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
