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

Tools

Slug: ONESIGNAL_USER_AUTH_CREATE_USERTool 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

string
required
Your OneSignal App ID in UUID v4 format.
object
required
Defines identifiers for the user. The external_id must be used and should be unique across users.
object
User profile data including tags, preferences, and other properties.
array
The subscriptions object allows for creating or transferring subscriptions to a specified user.

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

string
required
Your OneSignal App ID in UUID v4 format. See Keys & IDs documentation.
string
required
The specific identifier for the given alias to identify the user.
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.
string
required
The name of the alias to remove from the user.

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_USER_AUTH_EDIT_DEVICETool to update an existing OneSignal device (player) record. Use when you have the player_id and need to modify device attributes.

Input Parameters

number
Device latitude.
string
Version of the OneSignal SDK.
number
Device longitude.
object
Custom tags to set on the device.
string
Advertising identifier (IDFA or AAID).
string
OneSignal App ID the device belongs to.
string
Country code (e.g., ‘US’).
string
Locale code of the device (ISO 639-1).
integer
Seconds the player has been online.
integer
Offset in seconds from UTC (negative if behind).
string
Operating system version of the device.
string
required
Unique device (player) ID to update.
integer
Unix timestamp when the device was created.
string
Push token (e.g., FCM or APNS token) or email.
integer
Current iOS badge count displayed on the app icon.
integer
Last active time as a Unix timestamp.
number
Total amount spent by the user.
string
Hardware model of the device.
string
App version of the device.
integer
Number of times the app has been opened.
integer
1 = subscribed, -2 = unsubscribed (iOS only).

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

string
required
The OneSignal App ID to retrieve segment for.
string
required
The OneSignal Segment ID to retrieve details for.

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

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).
string
required
Your OneSignal App ID in UUID v4 format.
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.
object
required
The subscription properties to update.

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_USER_AUTH_VIEW_APPTool to retrieve details for a specific OneSignal app. Use after authenticating to inspect app settings.

Input Parameters

string
required
The OneSignal App ID to retrieve details for.

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

integer
The number of broadcasts to retrieve. Defaults to OneSignal default if omitted.
string
required
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
string
The exclusive lower bound of broadcasts to retrieve. Pass in successive requests to page through results.

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_USER_AUTH_VIEW_DEVICETool to retrieve details for a specific device/player. Use when you have a player_id and optional app_id.

Input Parameters

string
OneSignal App ID to scope the lookup. If omitted, uses the default app from authentication.
string
required
The OneSignal Player (device) ID to retrieve details for.

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_USER_AUTH_VIEW_OUTCOMESTool to view all outcomes associated with a OneSignal app. Use to retrieve outcome metrics filtered by time range, platforms, and attribution type.

Input Parameters

string
required
OneSignal App ID in UUID v4 format to retrieve outcomes for.
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’.
string
Comma-separated list of platform device_type integers to include. Defaults to ‘0,1,2,5,8,11,14,17’ if not specified.
string ("1h" | "1d" | "1mo")
Time range for outcome data.
string ("direct" | "influenced" | "unattributed" | "total")
Attribution type for outcomes.

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_USER_AUTH_VIEW_SEGMENTSTool to list all segments for an app. Use after obtaining the app_id to retrieve a paginated list of segments.

Input Parameters

integer
Number of segments to return (1 to 300). Defaults to OneSignal default if omitted.
string
required
OneSignal App ID to list segments for
integer
Offset for pagination (number of items to skip).

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

string
required
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
string
required
The specific identifier for the given alias to identify the user.
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

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_USER_AUTH_VIEW_USER_UNREAD_MESSAGE_COUNTRetrieve the unread inbox message count for a user identified by alias. The returned count defaults to zero if the response omits it.

Input Parameters

string
required
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
string
required
The identifier or value set for the desired 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

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