- Category: notifications
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 12
- Triggers: 0
- Slug:
ONESIGNAL_USER_AUTH - Version: 20261101_00
Tools
Create or Update OneSignal User
Create or Update OneSignal User
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
Defines identifiers for the user. The external_id must be used and should be unique across users.
The subscriptions object allows for creating or transferring subscriptions to a specified user.
Output
Delete User Alias
Delete User Alias
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
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
Edit OneSignal Device
Edit OneSignal Device
View OneSignal Segment
View OneSignal Segment
Update Subscription By Token
Update Subscription By Token
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
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 ("Email" | "SMS" | "iOSPush" | "AndroidPush" | "HuaweiPush" | "FireOSPush" | "WindowsPush" | "macOSPush" | "ChromeExtensionPush" | "ChromePush" | "FirefoxPush" | "SafariPush")
required
The subscription channel type. Must match the format of the token.
Output
View App
View App
View Broadcasts
View Broadcasts
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
The exclusive lower bound of broadcasts to retrieve. Pass in successive requests to page through results.
Output
View OneSignal Device
View OneSignal Device
View Outcomes
View Outcomes
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
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.
Output
View Segments
View Segments
View OneSignal User
View OneSignal User
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
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
View User Unread Message Count
View User Unread Message Count
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
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.