NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
OneSignal User Auth connects to a Nagent workspace with an API key. Once it is connected, agents can call 12 OneSignal User Auth actions, such as "Create or Update OneSignal User", "Update Subscription By Token" and "Delete User Alias". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against OneSignal User Auth, with input parameters and output schema.
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
Your OneSignal App ID in UUID v4 format.
Defines identifiers for the user. The external_id must be used and should be unique across users.
User profile data including tags, preferences, and other properties.
The subscriptions object allows for creating or transferring subscriptions to a specified user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Your OneSignal App ID in UUID v4 format. See Keys & IDs documentation.
The specific identifier for the given alias to identify the user.
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.
The name of the alias to remove from the user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Device latitude.
Version of the OneSignal SDK.
Device longitude.
Custom tags to set on the device.
Advertising identifier (IDFA or AAID).
OneSignal App ID the device belongs to.
Country code (e.g., 'US').
Locale code of the device (ISO 639-1).
Seconds the player has been online.
Offset in seconds from UTC (negative if behind).
Operating system version of the device.
Unique device (player) ID to update.
Unix timestamp when the device was created.
Push token (e.g., FCM or APNS token) or email.
Current iOS badge count displayed on the app icon.
Last active time as a Unix timestamp.
Total amount spent by the user.
Hardware model of the device.
App version of the device.
Number of times the app has been opened.
1 = subscribed, -2 = unsubscribed (iOS only).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The OneSignal App ID to retrieve segment for.
The OneSignal Segment ID to retrieve details for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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).
Your OneSignal App ID in UUID v4 format.
The subscription channel type. Must match the format of the token.
The subscription properties to update.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ONESIGNAL_USER_AUTH_VIEW_APPTool to retrieve details for a specific OneSignal app. Use after authenticating to inspect app settings.
Input parameters
The OneSignal App ID to retrieve details for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The number of broadcasts to retrieve. Defaults to OneSignal default if omitted.
Your OneSignal App ID in UUID v4 format. See \[Keys & IDs\](/docs/keys-and-ids).
The exclusive lower bound of broadcasts to retrieve. Pass in successive requests to page through results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
OneSignal App ID to scope the lookup. If omitted, uses the default app from authentication.
The OneSignal Player (device) ID to retrieve details for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
OneSignal App ID in UUID v4 format to retrieve outcomes for.
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'.
Comma-separated list of platform device_type integers to include. Defaults to '0,1,2,5,8,11,14,17' if not specified.
Time range for outcome data.
Attribution type for outcomes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Number of segments to return (1 to 300). Defaults to OneSignal default if omitted.
OneSignal App ID to list segments for
Offset for pagination (number of items to skip).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Your OneSignal App ID in UUID v4 format. See \[Keys & IDs\](/docs/keys-and-ids).
The specific identifier for the given alias to identify the user.
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\](/docs/aliases).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ONESIGNAL_USER_AUTH_VIEW_USER_UNREAD_MESSAGE_COUNTTool to retrieve the unread message count for a specific user. Use when you need to check how many unread inbox messages a user has.
Input parameters
Your OneSignal App ID in UUID v4 format. See \[Keys & IDs\](/docs/keys-and-ids).
The identifier or value set for the desired alias label.
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 12 OneSignal User Auth actions on Nagent, including "Create or Update OneSignal User", "Update Subscription By Token" and "Delete User Alias". Create or Update OneSignal User: Create a new user or modify the subscriptions associated with an existing user. Each action is listed on this page with its input parameters and its output.
OneSignal User Auth connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create or Update OneSignal User takes 2 required inputs: app_id and identity. It also takes 2 optional inputs: properties and subscriptions. It returns data, error and successful.