Connect OneSignal REST API to your AI agent
The OneSignal REST API enables developers to programmatically send push notifications, emails, and SMS, manage users and subscriptions, and configure apps.
We set up the connection using your own OneSignal REST API account, with keys you control, and keep it running. Your agent picks it up and starts doing the work.
What your agent can do in OneSignal REST API
Each one is a real action the agent can take on its own, the same things a person clicking around OneSignal REST API could do. Read-only by default; write actions are confirmed against your policy.
- 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.
How we connect it
- 1
Connect your account
You create a key in OneSignal REST API, a key you create and control, and paste it in once. It lives in a secrets store on your server, not with us.
- 2
Set the guardrails
Read-only by default. You choose which write actions the agent may take, and anything outside that policy gets confirmed with you first.
- 3
We keep it running
Health checks on every connection, updates handled for you, and we watch the first week of activity to make sure the work lands.
FAQ
OneSignal REST API questions, answered.
Ready to put OneSignal REST API to work?
Tell us what your team runs on. We set up the connection, secure it, and your agent takes it from there.
All product names, logos, and brands are property of their respective owners; used for identification only. ZeroToClaw is not affiliated with or endorsed by OneSignal REST API.