OneSignal REST API for AI agents
Agents read OneSignal REST API at once. Changes and sends are held for a person's approval by default.
About OneSignal REST API
The OneSignal REST API enables developers to programmatically send push notifications, emails, and SMS, manage users and subscriptions, and configure apps.
What an agent can do in OneSignal REST API
Every OneSignal REST API action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in OneSignal REST API without asking first. 7 actions.
- Fetch User IdentityTool 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.
- View OneSignal AppTool to retrieve metadata for a single OneSignal app. Use when you need to fetch app details by its ID.
- View DeviceTool to retrieve details of a specific device (player). Use when you have a OneSignal player_id and need current device info.
- View DevicesTool 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 NotificationsTool to retrieve details of multiple notifications. Use when you need to list notifications for a specific app.
- View SegmentsTool to view segments for a OneSignal app. Use when you need to list all segments associated with an app.
- Get Eligible In-App MessagesTool 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.
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 8 actions.
- Create NotificationTool to create and send a OneSignal push notification. Use when you have your message and target audience ready to dispatch notifications.
- Create UserTool to create a OneSignal user with optional subscriptions and aliases. Aliases provided in the payload will be used to look up an existing user.
- Begin Live ActivityTool 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 TemplateTool 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.
- Delete AliasTool 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 DeviceTool to delete a device (player) from a OneSignal app. Use when you need to remove a specific device by its player ID.
- Update DeviceTool to update properties of an existing device. Use when you need to modify device attributes after registration.
- Update SubscriptionTool to update an existing subscription's properties. Use when you need to modify subscription attributes like token, enabled status, or device information.
Changes wait in Needs you
Changes and sends in OneSignal REST API are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Related connectors
OneSignal REST API questions
Can an agent change data in OneSignal REST API on its own?
Not by default. Changes and sends in OneSignal REST API are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in OneSignal REST API?
This connector lists 7 read actions. Reads run at once, without waiting for approval.
How does OneSignal REST API connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.