OneSignal REST API

notifications 15 tools available

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

Connect OneSignal REST API Visit OneSignal REST API

About this integration

Connect OneSignal REST API to Definable to automate repetitive tasks, sync data with the rest of your stack, trigger on real-world events. Personas call OneSignal REST API's 15 tools directly from chat or scheduled flows. You can wire it into any persona to read, write, and react when an event fires.

Connect OneSignal REST API to Definable and it becomes a set of typed tools your agents plan with — triggered by events, run on schedules, or invoked mid-conversation. Every write is checked by the verifier before it lands.

Auth OAuth2 · 2 clicks

Tools 15 exposed

Plans All, incl. Free

Data Never trained on

OneSignal REST API · in workflows

What teams actually run.

Three patterns teams run with OneSignal REST API on day one. Each one is a plain-English prompt — no canvas, no glue code — and you can remix them into anything.

Trigger on event

│ Listen for a new event

│ Parse and validate the payload

└ Take an action with the linked tool

Daily summary

│ Pull yesterday's activity

│ Summarise with the model of your choice

└ Send the digest via email or Slack

Cross-tool sync

│ Read records from one app

│ Transform with a persona

└ Write the result back via this integration

15 tools available

The OneSignal REST API toolbox.

Every OneSignal REST API capability your agents can call, each with a typed schema the planner reads. The router picks the right tool per step; the verifier checks the result.

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.

Create Notification

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

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.

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.

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.

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.

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.

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.

Update Device

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

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.

View OneSignal App

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

View Device

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

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.

View Notifications

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

View Segments

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

See it run

One prompt, start to finish.

A real prompt, the OneSignal REST API tools it calls, and what comes back. This is the whole interface — describe the outcome, agents handle the rest.

❯

Run a real OneSignal REST API task end-to-end — plan it, execute across the API, and hand back a verified result.

onesignal_rest_api.begin_live_activity Tool to start a Live Activity on OneSignal. Use when you need to initiate a Live Activity

onesignal_rest_api.create_notification Tool to create and send a OneSignal push notification. Use when you have your message and

onesignal_rest_api.create_template Tool to create reusable message templates for push, email, and SMS channels. Use when you · verified

done

Done. OneSignal REST API responded across 3 calls, the verifier signed off, and the result is logged with every payload.

FAQ · OneSignal REST API

Questions, answered.

What teams ask before connecting OneSignal REST API.

01 What can I automate with OneSignal REST API on Definable?

Anything OneSignal REST API exposes through its API. Common notifications workflows on Definable include automate repetitive tasks, sync data with the rest of your stack, trigger on real-world events. Personas can call any of the 15 OneSignal REST API tools directly, then chain the result into another integration without you writing code.

02 How does OneSignal REST API authentication work?

OneSignal REST API uses API_KEY on Definable. You connect once from the integrations page, scoped to the permissions you choose, and from then on any persona that has the integration enabled can act on your behalf. Tokens are encrypted at rest and rotated automatically.

03 Is the OneSignal REST API integration included in my Definable plan?

Yes — every Definable plan, including Starter, includes access to all 15 OneSignal REST API tools. You only need a separate OneSignal REST API subscription if OneSignal REST API itself charges per seat or per API call.

04 Is using OneSignal REST API through Definable secure?

Every call from a persona to OneSignal REST API is logged with the user, persona, prompt, and response. Tokens never leave Definable's secrets vault, scopes are configurable per persona, and you can revoke access at any time from the integration page.

05 How do I get started with OneSignal REST API on Definable?

Sign up for Definable, open the integrations page, find OneSignal REST API, and connect via OAuth or API key. You can immediately attach OneSignal REST API to any persona and start running workflows. The free Starter plan includes 5,000 credits/month.

06 What OneSignal REST API actions does Definable expose?

Definable exposes all 15 OneSignal REST API actions as callable tools — including `Begin Live Activity`, `Create Notification`, `Create Template`, plus 12 more. Each tool gets a typed parameter schema so personas know exactly how to call it.