OneSignal REST API integration: operations for AI agents
OneSignal REST API connects to Type.com as an integration. This page lists the 37 operations documented for Claude and Codex in Type.com: 13 read, 14 write, 10 destructive.
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.
Categories: Email & Messaging
How to connect OneSignal REST API to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
37 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
37 operations listed.
Notifications
- Read
View notifications
View the details of multiple notifications
- Read
View notification
View the details of a single notification and outcomes associated with it
- Read
Export CSV of Events
Generate a compressed CSV report of all of the events data for a notification. This will return a URL immediately upon success but it may take several minutes for the CSV to become available at that URL depending on the volume of data.
- Write
Create notification
Sends notifications to your users
- Write
Notification History
- View the devices sent a message - OneSignal Paid Plan Required This method will return all devices that were sent the given notificationid of an Email or Push Notification if used within 7 days of the date sent.
- Destructive
Stop a scheduled or currently outgoing notification
Used to stop a scheduled or currently outgoing notification
Apps
- Read
View apps
View the details of all of your current OneSignal apps
- Read
View an app
View the details of a single OneSignal app
- Read
View Outcomes
View the details of all the outcomes associated with your app &x1F6A7; Requires Authentication Key Requires your OneSignal App's REST API Key, available in Keys & IDs.
- Read
Fetch user
Returns the User’s properties, Aliases, and Subscriptions.
- Read
Fetch user identity
Lists all Aliases for the User identified by (:aliaslabel, :aliasid).
- Read
Fetch aliases
Lists all Aliases for the User identified by :subscriptionid.
- Read
Get eligible iams
Manifest of In-App Messages the Subscription is eligible to display by the SDK.
- Write
Create an app
Creates a new OneSignal app
- Write
Create Segments
Create segments visible and usable in the dashboard and API - Required: OneSignal Paid Plan The Create Segment method is used when you want your server to programmatically create a segment instead of using the OneSignal Dashboard UI.
- Write
Update a Live Activity via Push
Updates a specified live activity.
- Write
Start Live Activity
Starts a Live Activity
- Write
Create user
Creates a User, optionally Subscriptions owned by the User as well as Aliases. Aliases provided in the payload will be used to look up an existing User.
- Write
Update user
Updates an existing User’s properties.
- Write
Identify user by alias
Upserts one or more Aliases to an existing User identified by (:aliaslabel, :aliasid).
- Write
Create subscription
Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.
- Write
Update subscription
Updates an existing Subscription’s properties.
- Write
Identify user by subscription id
Upserts one or more Aliases for the User identified by :subscriptionid.
- Write
Transfer subscription
Transfers this Subscription to the User identified by the identity in the payload.
- Destructive
Update an app
Updates the name or configuration settings of an existing OneSignal app
- Destructive
Delete Segments
Delete segments (not user devices) - Required: OneSignal Paid Plan You can delete a segment under your app by calling this API. You must provide an API key in the Authorization header that has admin access on the app.
- Destructive
Stop Live Activity
Stops a Live Activity
- Destructive
Edit tags with external user id
Update an existing device's tags in one of your OneSignal apps using the External User ID. Warning - Android SDK Data Synchronization Tags added through the Android SDK tagging methods may not update if using the API to change or update the same tag.
- Destructive
Delete user
Removes the User identified by (:aliaslabel, :aliasid), and all Subscriptions and Aliases
- Destructive
Delete alias
Deletes an alias by alias label
- Destructive
Delete subscription
Deletes the Subscription.
Players
- Read
View devices
View the details of multiple devices in one of your OneSignal apps Unavailable for Apps Over 80,000 Users For performance reasons, this method is not available for larger apps. Larger apps should use the CSV export API endpoint, which is much more performant.
- Read
View device
View the details of an existing device in one of your OneSignal apps
- Read
Export CSV of Players
Generate a compressed CSV export of all of your current user data This method can be used to generate a compressed CSV export of all of your current user data. It is a much faster alternative than retrieving this data using the /players API endpoint.
- Write
Add a device
Register a new device to one of your OneSignal apps &x1F6A7; Don't use this This API endpoint is designed to be used from our open source Mobile and Web Push SDKs. It is not designed for developers to use it directly, unless instructed to do so by OneSignal support.
- Destructive
Edit device
Update an existing device in one of your OneSignal apps
- Destructive
Delete a user record
Delete player - Required: Used to delete a single, specific Player ID record from a specific OneSignal app.
No operations match.
See How connections work for access and permissions, or browse all integrations.