> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OneSignal

> How to set up the OneSignal connector, plus the actions and events that are available.

![OneSignal](https://stackone-logos.com/api/onesignal/filled/svg)

v1.1.1[See changelog](https://docs.stackone.com/connectors/onesignal/changelog.md)

[63 actions](#actions) · [24 events](#events) · 1 auth method

Developer Tools
Marketing
Messaging

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/onesignal/guides/connector-profile/api-key.md)
>
> Uses OneSignal API keys sent as an Authorization header with the literal prefix "Key". The App API Key and App ID cover...

Optionally, configure receiving Events for OneSignal into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/onesignal/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/onesignal/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

63 actions

ActionDescription

View API Keys`onesignal_view_api_keys`

Retrieve the details of every app API key (Rich Authentication Token) registered against a OneSignal app.

Create API Key`onesignal_create_api_key`

Create a new app API key (Rich Authentication Token) for a OneSignal app, optionally restricted to an IP allowlist.

Update API Key`onesignal_update_api_key`

Rename an existing app API key or change its IP allowlist settings, leaving its secret value unchanged.

Delete API Key`onesignal_delete_api_key`

Permanently revoke one app API key so it can no longer authenticate requests.

Rotate API Key`onesignal_rotate_api_key`

Issue a new secret for an existing app API key while keeping its token\_id, name and IP allowlist unchanged.

View Apps`onesignal_view_apps`

Retrieve every OneSignal app belonging to the organization behind the Organization API Key.

View An App`onesignal_view_an_app`

Retrieve the full metadata and push platform configuration of the configured OneSignal app.

Create An App`onesignal_create_an_app`

Create a new OneSignal app, optionally configuring its Web, Android and iOS push credentials in the same call.

Update An App`onesignal_update_an_app`

Update the name or the Web, Android and iOS push platform configuration of the configured OneSignal app.

List Audit Logs`onesignal_list_audit_logs`

Retrieve a paginated, time-scoped list of audit log events for a OneSignal organization.

Create Custom Events`onesignal_create_custom_events`

Record one or more custom events for OneSignal users to feed Journey triggers and analytics.

Export Subscriptions CSV`onesignal_export_subscriptions_csv`

Start an asynchronous background job that generates a GZip-compressed CSV of the app's subscription records and returns...

Export Audience Activity CSV`onesignal_export_csv_of_events`

Start an asynchronous background job that generates a compressed CSV of per-recipient delivery and engagement events for...

View Broadcasts`onesignal_view_broadcasts`

Retrieve the inbox broadcasts sent to an app's audience, each with its delivery stats.

Create Inbox Broadcast Message`onesignal_create_inbox_broadcast_message`

Broadcast a message into the in-app inbox of the app's users.

View Journeys`onesignal_view_journeys`

Retrieve a paginated list of journeys configured for a OneSignal app.

View Journey`onesignal_view_journey`

Retrieve the full configuration of a single journey by its UUID.

View Journey Stats`onesignal_view_journey_stats`

Retrieve entry, exit, node and branch level performance counters for a single journey.

Create Journey`onesignal_create_journey`

Create a new journey in draft state with an audience, optional scheduling and an initial node graph.

Update Journey`onesignal_update_journey`

Apply a full or partial update to a journey's top-level fields, including its state and node graph.

Delete Journey`onesignal_delete_journey`

Permanently delete a journey by its UUID.

Update Journey Node`onesignal_update_journey_node`

Apply a JSON Merge Patch to a single node inside a journey's node graph.

Start Live Activity`onesignal_start_live_activity`

Remotely start an iOS Live Activity on targeted devices.

Update Live Activity`onesignal_update_live_activity_api`

Push a content update to a running iOS Live Activity, or end it.

View Messages`onesignal_view_messages`

Retrieve a collection of messages previously sent or scheduled for a OneSignal app.

View Message`onesignal_view_message`

Retrieve the full definition and delivery counters of a single message.

Cancel Message`onesignal_cancel_message`

Stop a scheduled or currently outgoing message.

Get Message History`onesignal_get_message_history`

Request a report of which subscriptions were sent or clicked a particular message.

Estimate Notification Recipients`onesignal_count_unsaved`

Return the estimated recipient count for a set of targeting criteria without creating or sending a message.

Unsubscribe Email (With Token)`onesignal_unsubscribe_with_token`

Disable the email subscription tied to a sent message using its unsubscribe token.

Create Push Notification`onesignal_create_push_notification`

Send or schedule a push notification to app and web subscribers of a OneSignal app.

Create Email Message`onesignal_create_email_message`

Send or schedule an email to the email subscriptions of a OneSignal app.

Create SMS Message`onesignal_create_sms_message`

Send or schedule an SMS or MMS message to the phone numbers of a OneSignal app.

View Outcomes`onesignal_view_outcomes`

Retrieve aggregated outcome metrics attributed back to the messages that drove them.

View Segments`onesignal_view_segments`

Retrieve the segments configured for a OneSignal app.

View Segment`onesignal_view_segment`

Retrieve a single segment's subscriber count and, optionally, its metadata and filter definition.

Create Segment`onesignal_create_segments`

Create a saved audience segment in a OneSignal app from a chain of tag, activity and location filters.

Update Segment`onesignal_update_segment`

Rename a segment and optionally replace its entire filter definition.

Delete Segment`onesignal_delete_segments`

Permanently delete a segment definition from a OneSignal app.

View User Identity (By Subscription)`onesignal_fetch_identity_by_subscription`

Retrieve every alias bound to the user who owns a given OneSignal subscription.

Create Subscription By Alias`onesignal_create_subscription`

Attach a new push, email or SMS subscription to an existing OneSignal user identified by an alias.

Create Alias (By Subscription)`onesignal_create_alias_by_subscription`

Create or update aliases on the user who owns a given OneSignal subscription.

Update Subscription`onesignal_update_subscription`

Update the properties of an existing OneSignal subscription addressed by its subscription ID.

Update Subscription By Token`onesignal_update_subscription_by_token`

Update the properties of an existing OneSignal subscription addressed by its raw channel token.

Transfer Subscription`onesignal_transfer_subscription`

Move a known OneSignal subscription, addressed by its subscription\_id, to a different user within the same app.

Delete Subscription`onesignal_delete_subscription`

Permanently delete a OneSignal subscription by its subscription ID.

View Templates`onesignal_view_templates`

Retrieve a paginated list of message templates configured for the OneSignal app.

View Template`onesignal_view_template`

Retrieve the full details of a single message template by its template ID.

Create Template`onesignal_create_template`

Create a reusable push, email or SMS message template on the OneSignal app.

Update Template`onesignal_update_template`

Update the name or channel content of an existing message template.

Delete Template`onesignal_delete_template`

Permanently delete a message template from the OneSignal app by its template ID.

Copy Template To Another App`onesignal_copy_template_to_another_app`

Duplicate a message template into another app in the same OneSignal organization.

View User Broadcasts`onesignal_view_user_inbox_messages`

List the in-app inbox broadcasts delivered to a single OneSignal user, located by an alias pair.

View User Unread Message Count`onesignal_view_user_unread_message_count`

Retrieve the number of unread in-app inbox messages for a single OneSignal user.

Update Message State`onesignal_update_message_state`

Update the read, opened or deleted state of one specific in-app inbox message for a OneSignal user.

Bulk Update Or Delete Message State`onesignal_bulk_update_or_delete_message_state`

Update the read, opened or deleted state of many of a user's in-app inbox messages at once, across a range bounded by la...

View User`onesignal_view_user`

Retrieve a single OneSignal user, including aliases, properties and subscriptions, by a known alias pair.

View User Identity`onesignal_fetch_aliases`

Retrieve every alias attached to a OneSignal user, located by any one known alias pair.

Create User`onesignal_create_user`

Create a OneSignal user with its identity, profile properties and channel subscriptions.

Create Or Update Alias`onesignal_create_alias`

Add or update one or more aliases on a OneSignal user located by a known alias pair.

Update User`onesignal_update_user`

Modify the properties of a OneSignal user, or apply incremental deltas, using a known alias pair.

Delete User`onesignal_delete_user`

Permanently delete a OneSignal user, with all of its properties, aliases and subscriptions, by alias pair.

Delete Alias`onesignal_delete_alias`

Remove one alias label from a OneSignal user, located by a known alias pair, keeping the user intact.

## Events

Tags

Select all
|
Clear

Email

In-App Messages

Live Activities

Push

SMS

Webhooks

No tags found

24 events

EventDescriptionTags

Push Delivered`onesignal_webhook_push_sent`

Processes events fired when a push notification is delivered to the push service.

PushWebhooks

Push Confirmed Receipt`onesignal_webhook_push_received`

Processes events fired when a push notification is received on the device.

PushWebhooks

Push Clicked`onesignal_webhook_push_clicked`

Processes events fired when a recipient taps a push notification.

PushWebhooks

Push Failed`onesignal_webhook_push_failed`

Processes events fired when a push notification fails to send.

PushWebhooks

Push Unsubscribed`onesignal_webhook_push_unsubscribed`

Processes events fired when a push subscription is found unreachable.

PushWebhooks

In-App Impression`onesignal_webhook_iam_impression`

Processes events fired when an in-app message is displayed.

In-App MessagesWebhooks

In-App Clicked`onesignal_webhook_iam_clicked`

Processes events fired when a recipient taps an element in an in-app message.

In-App MessagesWebhooks

In-App Card Displayed`onesignal_webhook_iam_page_displayed`

Processes events fired when an in-app message page is displayed.

In-App MessagesWebhooks

Email Delivered`onesignal_webhook_email_received`

Processes events fired when an email is accepted by the recipient's mail server.

EmailWebhooks

Email Opened`onesignal_webhook_email_opened`

Processes events fired when a recipient opens an email.

EmailWebhooks

Email Link Clicked`onesignal_webhook_email_clicked`

Processes events fired when a recipient clicks a link in an email.

EmailWebhooks

Email Unsubscribed`onesignal_webhook_email_unsubscribed`

Processes events fired when a recipient unsubscribes from email.

EmailWebhooks

Email Reported as Spam`onesignal_webhook_email_reported_as_spam`

Processes events fired when a recipient reports an email as spam.

EmailWebhooks

Email Bounced`onesignal_webhook_email_bounced`

Processes events fired when an email bounces.

EmailWebhooks

Email Failed`onesignal_webhook_email_failed`

Processes events fired when an email cannot be delivered.

EmailWebhooks

Email Suppressed`onesignal_webhook_email_suppressed`

Processes events fired when an email is blocked by the suppression list.

EmailWebhooks

SMS Delivered`onesignal_webhook_sms_delivered`

Processes events fired when an SMS is confirmed delivered by the carrier.

SMSWebhooks

SMS Failed`onesignal_webhook_sms_failed`

Processes events fired when an SMS fails to send.

SMSWebhooks

SMS Undelivered`onesignal_webhook_sms_undelivered`

Processes events fired when an SMS cannot be delivered.

SMSWebhooks

Live Activity Delivered`onesignal_webhook_live_activity_sent`

Processes events fired when a Live Activity update is sent to APNs.

Live ActivitiesWebhooks

Live Activity Confirmed Receipt`onesignal_webhook_live_activity_delivered`

Processes events fired when a Live Activity update reaches the device.

Live ActivitiesWebhooks

Live Activity Clicked`onesignal_webhook_live_activity_clicked`

Processes events fired when a recipient taps a Live Activity.

Live ActivitiesWebhooks

Live Activity Failed`onesignal_webhook_live_activity_failed`

Processes events fired when a Live Activity update fails to send.

Live ActivitiesWebhooks

Live Activity Unsubscribed`onesignal_webhook_live_activity_unsubscribed`

Processes events fired when a recipient unsubscribes from Live Activities.

Live ActivitiesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.