# OneSignal REST API

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

- **Category:** notifications
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 15
- **Triggers:** 0
- **Slug:** `ONESIGNAL_REST_API`
- **Version:** 20260417_00

## Tools

### Begin Live Activity

**Slug:** `ONESIGNAL_REST_API_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

**Slug:** `ONESIGNAL_REST_API_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

**Slug:** `ONESIGNAL_REST_API_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

**Slug:** `ONESIGNAL_REST_API_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

**Slug:** `ONESIGNAL_REST_API_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

**Slug:** `ONESIGNAL_REST_API_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

**Slug:** `ONESIGNAL_REST_API_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

**Slug:** `ONESIGNAL_REST_API_GET_ELIGIBLE_IAMS`

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

**Slug:** `ONESIGNAL_REST_API_UPDATE_DEVICE`

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

### Update Subscription

**Slug:** `ONESIGNAL_REST_API_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

**Slug:** `ONESIGNAL_REST_API_VIEW_AN_APP`

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

### View Device

**Slug:** `ONESIGNAL_REST_API_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

**Slug:** `ONESIGNAL_REST_API_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

**Slug:** `ONESIGNAL_REST_API_VIEW_NOTIFICATIONS`

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

### View Segments

**Slug:** `ONESIGNAL_REST_API_VIEW_SEGMENTS`

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