OneSignal User Auth
onesignal_user_authOneSignal is a customer engagement platform offering push notifications, email, SMS, and in-app messaging services.
Acciones disponibles (7)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add or Update Device TagsONESIGNAL_USER_AUTH_ADD_TAGSAcciónTool to assign or update tags on a onesignal device. use when you need to apply or change custom tags for a player for segmentation.
ONESIGNAL_USER_AUTH_ADD_TAGSAcciónTool to assign or update tags on a onesignal device. use when you need to apply or change custom tags for a player for segmentation.
Parámetros de entrada
tagsobjectObligatorioMapping of tag keys to values. Keys must be strings (max length 30) and values can be strings or null to delete a tag. Up to 20 tags may be provided.
app_idstringObligatorioOneSignal App ID to associate the tags update.
player_idstringObligatorioUnique OneSignal player (device) ID to update tags for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit OneSignal DeviceONESIGNAL_USER_AUTH_EDIT_DEVICEAcciónTool to update an existing onesignal device (player) record. use when you have the player id and need to modify device attributes.
ONESIGNAL_USER_AUTH_EDIT_DEVICEAcciónTool to update an existing onesignal device (player) record. use when you have the player id and need to modify device attributes.
Parámetros de entrada
latnumberDevice latitude.
sdkstringVersion of the OneSignal SDK.
longnumberDevice longitude.
tagsobjectCustom tags to set on the device.
ad_idstringAdvertising identifier (IDFA or AAID).
app_idstringOneSignal App ID the device belongs to.
countrystringCountry code (e.g., 'US').
languagestringLocale code of the device (ISO 639-1).
playtimeintegerSeconds the player has been online.
timezoneintegerOffset in seconds from UTC (negative if behind).
device_osstringOperating system version of the device.
player_idstringObligatorioUnique device (player) ID to update.
created_atintegerUnix timestamp when the device was created.
identifierstringPush token (e.g., FCM or APNS token) or email.
badge_countintegerCurrent iOS badge count displayed on the app icon.
last_activeintegerLast active time as a Unix timestamp.
amount_spentnumberTotal amount spent by the user.
device_modelstringHardware model of the device.
game_versionstringApp version of the device.
session_countintegerNumber of times the app has been opened.
notification_typesinteger1 = subscribed, -2 = unsubscribed (iOS only).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
View OneSignal SegmentONESIGNAL_USER_AUTH_ONESIGNAL_VIEW_SEGMENTAcciónTool to retrieve details for a specific onesignal segment. use when you need to inspect segment definition.
ONESIGNAL_USER_AUTH_ONESIGNAL_VIEW_SEGMENTAcciónTool to retrieve details for a specific onesignal segment. use when you need to inspect segment definition.
Parámetros de entrada
app_idstringObligatorioThe OneSignal App ID to retrieve segment for.
segment_idstringObligatorioThe OneSignal Segment ID to retrieve details for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
View AppONESIGNAL_USER_AUTH_VIEW_APPAcciónTool to retrieve details for a specific onesignal app. use after authenticating to inspect app settings.
ONESIGNAL_USER_AUTH_VIEW_APPAcciónTool to retrieve details for a specific onesignal app. use after authenticating to inspect app settings.
Parámetros de entrada
app_idstringObligatorioThe OneSignal App ID to retrieve details for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
View OneSignal DeviceONESIGNAL_USER_AUTH_VIEW_DEVICEAcciónTool to retrieve details for a specific device/player. use when you have a player id and optional app id.
ONESIGNAL_USER_AUTH_VIEW_DEVICEAcciónTool to retrieve details for a specific device/player. use when you have a player id and optional app id.
Parámetros de entrada
app_idstringOneSignal App ID to scope the lookup. If omitted, uses the default app from authentication.
player_idstringObligatorioThe OneSignal Player (device) ID to retrieve details for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
View SegmentsONESIGNAL_USER_AUTH_VIEW_SEGMENTSAcciónTool to list all segments for an app. use after obtaining the app id to retrieve a paginated list of segments.
ONESIGNAL_USER_AUTH_VIEW_SEGMENTSAcciónTool to list all segments for an app. use after obtaining the app id to retrieve a paginated list of segments.
Parámetros de entrada
limitintegerNumber of segments to return (1 to 300). Defaults to OneSignal default if omitted.
app_idstringObligatorioOneSignal App ID to list segments for
offsetintegerOffset for pagination (number of items to skip).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
View OneSignal Device TagsONESIGNAL_USER_AUTH_VIEW_TAGSAcciónTool to get tags assigned to a device. use when you need to fetch key/value tags for a specific onesignal player.
ONESIGNAL_USER_AUTH_VIEW_TAGSAcciónTool to get tags assigned to a device. use when you need to fetch key/value tags for a specific onesignal player.
Parámetros de entrada
app_idstringObligatorioOneSignal App ID to scope the lookup
player_idstringObligatorioThe OneSignal Player (device) ID to retrieve tags for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not