View all systems 
OneSignal REST APInotifications
15 available actions
What your AI agent can do in OneSignal REST API
The OneSignal REST API enables developers to programmatically send push notifications, emails, and SMS, manage users and subscriptions, and configure apps. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 15 actions.
Common starting points
- Get Eligible In-App MessagesTool to retrieve the manifest of In-App Messages that a subscription is eligible to display.
- View OneSignal AppTool to retrieve metadata for a single OneSignal app.
- Create NotificationTool to create and send a OneSignal push notification.
- Create TemplateTool to create reusable message templates for push, email, and SMS channels.
- Update DeviceTool to update properties of an existing device.
- Update SubscriptionTool to update an existing subscription's properties.
Browse all 15 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 7 actions
- Fetch User IdentityTool to retrieve all aliases for a user identified by a specific alias.
- Get Eligible In-App MessagesTool to retrieve the manifest of In-App Messages that a subscription is eligible to display.
- View OneSignal AppTool to retrieve metadata for a single OneSignal app.
- View DeviceTool to retrieve details of a specific device (player).
- View DevicesTool to retrieve a paginated list of devices (players) for a OneSignal app.
- View NotificationsTool to retrieve details of multiple notifications.
- View SegmentsTool to view segments for a OneSignal app.
Create & communicateCreate records or send supported messagesView 3 actions
- Create NotificationTool to create and send a OneSignal push notification.
- Create TemplateTool to create reusable message templates for push, email, and SMS channels.
- Create UserTool to create a OneSignal user with optional subscriptions and aliases.
Update & manageChange and manage existing recordsView 2 actions
- Update DeviceTool to update properties of an existing device.
- Update SubscriptionTool to update an existing subscription's properties.
Remove & cancelRemove records or cancel supported workView 2 actions
- Delete AliasTool to delete an alias by alias label from a OneSignal user.
- Delete DeviceTool to delete a device (player) from a OneSignal app.
Other actionsSpecialist and administrative actions.View 1 action
- Begin Live ActivityTool to start a Live Activity on OneSignal.
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect OneSignal REST API
How does the agent connect to OneSignal REST API?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in OneSignal REST API?
The page above lists the 15 actions currently available through the OneSignal REST API connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is OneSignal REST API included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until OneSignal REST API is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put OneSignal REST API to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.