Integrations›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.

Supported tools and triggers

Each tool is a typed function your agent can call. Each trigger fires an agent run when something changes upstream.

Begin Live Activity

Tool to start a Live Activity on OneSignal. Use when you need to initiate a Live Activity session with a push token and subscription ID.

TOOL

Create Notification

Tool to create and send a OneSignal push notification. Use when you have your message and target audience ready to dispatch notifications.

TOOL

Create Template

Tool to create reusable message templates for push, email, and SMS channels. Use when you need to create a template that can be accessed through both the dashboard and API using a template_id.

TOOL

Create User

Tool to create a OneSignal user with optional subscriptions and aliases. Aliases provided in the payload will be used to look up an existing user.

TOOL

Delete Alias

Tool to delete an alias by alias label from a OneSignal user. Use when you need to remove a specific alias identity from a user's profile.

TOOL

Delete Device

Tool to delete a device (player) from a OneSignal app. Use when you need to remove a specific device by its player ID.

TOOL

Fetch User Identity

Tool to retrieve all aliases for a user identified by a specific alias. Use when you need to fetch the complete identity mapping for a OneSignal user.

TOOL

Get Eligible In-App Messages

Tool to retrieve the manifest of In-App Messages that a subscription is eligible to display. Use when you need to fetch eligible IAMs for a specific subscription.

TOOL

Update Device

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

TOOL

Update Subscription

Tool to update an existing subscription's properties. Use when you need to modify subscription attributes like token, enabled status, or device information.

TOOL

View Device

Tool to retrieve details of a specific device (player). Use when you have a OneSignal player_id and need current device info.

TOOL

View Devices

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.

TOOL

View Notifications

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

TOOL

View OneSignal App

Tool to retrieve metadata for a single OneSignal app. Use when you need to fetch app details by its ID.

TOOL

View Segments

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

TOOL