NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

OneSignal REST API

onesignal_rest_api

The OneSignal REST API enables developers to programmatically send push notifications, emails, and SMS, manage users and subscriptions, and configure apps.

NotificationsPhone & SMSWeb del proveedor
Acciones
8
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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

  • urlstringuri

    URL to open when the notification is tapped

  • dataobject

    Custom key/value data payload

  • app_idstringObligatorio

    Your OneSignal App ID

  • buttonsobject[]

    Action buttons; see OneSignal docs for fields (id, text, icon, url)

  • filtersobject[]

    Advanced audience filters; see OneSignal docs for syntax

  • contentsobjectObligatorio

    Notification message per language

  • headingsobject

    Notification title per language

  • subtitleobject

    Notification subtitle per language

  • ios_soundstring

    Custom iOS sound file

  • large_iconstringuri

    URL for Android large icon

  • send_afterstring

    Schedule delivery time in ISO 8601 format (e.g., '2023-09-01T12:00:00Z')

  • big_picturestringuri

    URL for Android big picture

  • extra_paramsobject

    Additional OneSignal parameters not explicitly modeled above

  • android_soundstring

    Custom Android sound file

  • delayed_optionstringenum

    Delay delivery based on 'timezone' or 'last-active'

    timezonelast-active
  • ios_attachmentsobject

    iOS media attachments mapping identifiers to URLs

  • included_segmentsstring[]

    Predefined audience segments (e.g., ['All'])

  • android_channel_idstring

    Android channel ID to post notification to

  • include_player_idsstring[]

    Specific device/player IDs to send the notification to

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete DeviceONESIGNAL_REST_API_DELETE_DEVICEAcción

Tool 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_idstringObligatorio

    The OneSignal App ID

  • player_idstringObligatorio

    The OneSignal Player (Device) ID to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update DeviceONESIGNAL_REST_API_UPDATE_DEVICEAcción

Tool to update properties of an existing device. use when you need to modify device attributes after registration.

Parámetros de entrada

  • tagsobject

    Custom tags for the device

  • ad_idstring

    Advertising ID

  • app_idstringObligatorio

    Your OneSignal App ID

  • countrystring

    Country code, e.g., 'US'

  • languagestring

    Language code, e.g., 'en'

  • latitudenumber

    Latitude coordinate

  • playtimeinteger

    Total playtime in seconds

  • timezoneinteger

    Timezone offset in seconds from UTC

  • device_osstring

    Operating system version

  • longitudenumber

    Longitude coordinate

  • player_idstringObligatorio

    Unique OneSignal device/player ID

  • test_typeinteger

    1 for development, 2 for ad-hoc

  • created_atinteger

    Unix timestamp when the device was created

  • identifierstring

    Push token, email address, or external user ID

  • badge_countinteger

    iOS badge count

  • device_typeinteger

    Device type. See OneSignal docs for list

  • last_activeinteger

    Unix timestamp when the device was last active

  • amount_spentstring

    Amount the user has spent

  • device_modelstring

    Device model

  • game_versionstring

    Version of the app/game

  • sms_auth_hashstring

    SMS authentication hash

  • email_auth_hashstring

    Email authentication hash

  • external_user_idstring

    External user ID

  • custom_attributesobject

    Additional custom attributes

  • notification_typesinteger

    Notification permission state

  • external_user_id_auth_hashstring

    Auth hash for external_user_id

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

View OneSignal AppONESIGNAL_REST_API_VIEW_AN_APPAcción

Tool to retrieve metadata for a single onesignal app. use when you need to fetch app details by its id.

Parámetros de entrada

  • app_idstringObligatorio

    Unique identifier for the OneSignal app.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

View DeviceONESIGNAL_REST_API_VIEW_DEVICEAcción

Tool 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_idstringObligatorio

    Your OneSignal App ID.

  • player_idstringObligatorio

    Unique ID of the device (player) to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

View DevicesONESIGNAL_REST_API_VIEW_DEVICESAcción

Tool 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

  • limitinteger

    Maximum number of devices to return (1-300). Defaults to 300.

  • app_idstringObligatorio

    Your OneSignal App ID.

  • offsetinteger

    Pagination offset. Defaults to 0.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

View NotificationsONESIGNAL_REST_API_VIEW_NOTIFICATIONSAcción

Tool to retrieve details of multiple notifications. use when you need to list notifications for a specific app.

Parámetros de entrada

  • limitinteger

    Maximum number of notifications to return (1-300). Defaults to 50.

  • app_idstringObligatorio

    Your OneSignal App ID.

  • offsetinteger

    Result offset for pagination. Defaults to 0.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

View SegmentsONESIGNAL_REST_API_VIEW_SEGMENTSAcción

Tool to view segments for a onesignal app. use when you need to list all segments associated with an app.

Parámetros de entrada

  • limitinteger

    Maximum number of segments to return (1-300). Default is 50.

  • app_idstringObligatorio

    OneSignal App ID to list segments for

  • offsetinteger

    Zero-based offset for pagination. Results sorted by creation time.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not