API_KEY
onesignal_rest_api_api_key
Developer setup
No fields declared in this snapshot.
User connection
- OneSignal App API Keygeneric_api_key · stringRequired
All integrations
OR
Catalogue metadata onlynotificationsv20260826_00
ONESIGNAL_REST_API
OneSignal REST API
The OneSignal REST API enables developers to programmatically send push notifications, emails, and SMS, manage users and subscriptions, and configure apps.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
No Pakkawork execution adapter is enabled. Hosted account-authorisation availability is workspace-specific and checked separately in the dashboard.Check workspace connection options
Attributed source 15
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
What setup is declared?
Only field names, types, and required markers are shown. Secret values, default auth URLs, credential material, and inferred OAuth scopes are excluded.
API_KEY
Provider setup
Capability index
Actions and trigger definitions
Static summaries are available. Live schemas remain disabled until PROVIDER_HUB_API_KEY is configured server-side.
Showing 1–15 of 15 actions
Begin Live Activity
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.
Untrusted display-only summary
Create Notification
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.
Untrusted display-only summary
Create Template
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.
Untrusted display-only summary
Create User
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.
Untrusted display-only summary
Delete Alias
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.
Untrusted display-only summary
Delete Device
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.
Untrusted display-only summary
Fetch User Identity
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.
Untrusted display-only summary
Get Eligible In-App Messages
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.
Untrusted display-only summary
Update Device
ONESIGNAL_REST_API_UPDATE_DEVICE
Tool to update properties of an existing device. Use when you need to modify device attributes after registration.
Untrusted display-only summary
Update Subscription
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.
Untrusted display-only summary
View OneSignal App
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.
Untrusted display-only summary
View Device
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.
Untrusted display-only summary
View Devices
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.
Untrusted display-only summary
View Notifications
ONESIGNAL_REST_API_VIEW_NOTIFICATIONS
Tool to retrieve details of multiple notifications. Use when you need to list notifications for a specific app.
Untrusted display-only summary
View Segments
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.
Untrusted display-only summary
Provenance
Versioned facts, explicit trust.
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
- Repository
- https://github.com/provider-directoryHQ/provider-directory
- Commit
- 85e33f6a81dfe987f6fc3637d48d45052cea8ca5
- Generated
- 2026-09-12
- Trust policy
- untrusted_display_only
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.