OneSignal REST API
onesignal_rest_apiThe OneSignal REST API enables developers to programmatically send push notifications, emails, and SMS, manage users and subscriptions, and configure apps.
Acciones disponibles (8)
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.
Create NotificationONESIGNAL_REST_API_CREATE_NOTIFICATIONAcciónTool to create and send a onesignal push notification. use when you have your message and target audience ready to dispatch notifications.
ONESIGNAL_REST_API_CREATE_NOTIFICATIONAcciónTool to create and send a onesignal push notification. use when you have your message and target audience ready to dispatch notifications.
Parámetros de entrada
urlstringuriURL to open when the notification is tapped
dataobjectCustom key/value data payload
app_idstringObligatorioYour OneSignal App ID
buttonsobject[]Action buttons; see OneSignal docs for fields (id, text, icon, url)
filtersobject[]Advanced audience filters; see OneSignal docs for syntax
contentsobjectObligatorioNotification message per language
headingsobjectNotification title per language
subtitleobjectNotification subtitle per language
ios_soundstringCustom iOS sound file
large_iconstringuriURL for Android large icon
send_afterstringSchedule delivery time in ISO 8601 format (e.g., '2023-09-01T12:00:00Z')
big_picturestringuriURL for Android big picture
extra_paramsobjectAdditional OneSignal parameters not explicitly modeled above
android_soundstringCustom Android sound file
delayed_optionstringenumDelay delivery based on 'timezone' or 'last-active'
timezonelast-activeios_attachmentsobjectiOS media attachments mapping identifiers to URLs
included_segmentsstring[]Predefined audience segments (e.g., ['All'])
android_channel_idstringAndroid channel ID to post notification to
include_player_idsstring[]Specific device/player IDs to send the notification to
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
Delete DeviceONESIGNAL_REST_API_DELETE_DEVICEAcciónTool to delete a device (player) from a onesignal app. use when you need to remove a specific device by its player id.
ONESIGNAL_REST_API_DELETE_DEVICEAcciónTool to delete a device (player) from a onesignal app. use when you need to remove a specific device by its player id.
Parámetros de entrada
app_idstringObligatorioThe OneSignal App ID
player_idstringObligatorioThe OneSignal Player (Device) ID to delete
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
Update DeviceONESIGNAL_REST_API_UPDATE_DEVICEAcciónTool to update properties of an existing device. use when you need to modify device attributes after registration.
ONESIGNAL_REST_API_UPDATE_DEVICEAcciónTool to update properties of an existing device. use when you need to modify device attributes after registration.
Parámetros de entrada
tagsobjectCustom tags for the device
ad_idstringAdvertising ID
app_idstringObligatorioYour OneSignal App ID
countrystringCountry code, e.g., 'US'
languagestringLanguage code, e.g., 'en'
latitudenumberLatitude coordinate
playtimeintegerTotal playtime in seconds
timezoneintegerTimezone offset in seconds from UTC
device_osstringOperating system version
longitudenumberLongitude coordinate
player_idstringObligatorioUnique OneSignal device/player ID
test_typeinteger1 for development, 2 for ad-hoc
created_atintegerUnix timestamp when the device was created
identifierstringPush token, email address, or external user ID
badge_countintegeriOS badge count
device_typeintegerDevice type. See OneSignal docs for list
last_activeintegerUnix timestamp when the device was last active
amount_spentstringAmount the user has spent
device_modelstringDevice model
game_versionstringVersion of the app/game
sms_auth_hashstringSMS authentication hash
email_auth_hashstringEmail authentication hash
external_user_idstringExternal user ID
custom_attributesobjectAdditional custom attributes
notification_typesintegerNotification permission state
external_user_id_auth_hashstringAuth hash for external_user_id
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 AppONESIGNAL_REST_API_VIEW_AN_APPAcciónTool to retrieve metadata for a single onesignal app. use when you need to fetch app details by its id.
ONESIGNAL_REST_API_VIEW_AN_APPAcciónTool to retrieve metadata for a single onesignal app. use when you need to fetch app details by its id.
Parámetros de entrada
app_idstringObligatorioUnique identifier for the OneSignal app.
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 DeviceONESIGNAL_REST_API_VIEW_DEVICEAcciónTool to retrieve details of a specific device (player). use when you have a onesignal player id and need current device info.
ONESIGNAL_REST_API_VIEW_DEVICEAcciónTool to retrieve details of a specific device (player). use when you have a onesignal player id and need current device info.
Parámetros de entrada
app_idstringObligatorioYour OneSignal App ID.
player_idstringObligatorioUnique ID of the device (player) to retrieve.
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 DevicesONESIGNAL_REST_API_VIEW_DEVICESAcciónTool to retrieve a paginated list of devices (players) for a onesignal app. use when you need to list or audit all registered devices for a given app.
ONESIGNAL_REST_API_VIEW_DEVICESAcciónTool to retrieve a paginated list of devices (players) for a onesignal app. use when you need to list or audit all registered devices for a given app.
Parámetros de entrada
limitintegerMaximum number of devices to return (1-300). Defaults to 300.
app_idstringObligatorioYour OneSignal App ID.
offsetintegerPagination offset. Defaults to 0.
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 NotificationsONESIGNAL_REST_API_VIEW_NOTIFICATIONSAcciónTool to retrieve details of multiple notifications. use when you need to list notifications for a specific app.
ONESIGNAL_REST_API_VIEW_NOTIFICATIONSAcciónTool to retrieve details of multiple notifications. use when you need to list notifications for a specific app.
Parámetros de entrada
limitintegerMaximum number of notifications to return (1-300). Defaults to 50.
app_idstringObligatorioYour OneSignal App ID.
offsetintegerResult offset for pagination. Defaults to 0.
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_REST_API_VIEW_SEGMENTSAcciónTool to view segments for a onesignal app. use when you need to list all segments associated with an app.
ONESIGNAL_REST_API_VIEW_SEGMENTSAcciónTool to view segments for a onesignal app. use when you need to list all segments associated with an app.
Parámetros de entrada
limitintegerMaximum number of segments to return (1-300). Default is 50.
app_idstringObligatorioOneSignal App ID to list segments for
offsetintegerZero-based offset for pagination. Results sorted by creation time.
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