# OneSignal

> OneSignal is a platform for sending push notifications, emails, in-app messages, and SMS campaigns via a single API, Journey Builder, and a dashboard.

## Docs

- [2-step authentication](https://documentation.onesignal.com/docs/en/2-step-authentication.md): Set up, manage, and recover Two-Factor Authentication (2FA) for your OneSignal account, including recovery codes, transferring to a new device, and regaining access if locked out.
- [A/B Testing](https://documentation.onesignal.com/docs/en/ab-testing.md): Optimize your push and email messaging with OneSignal's A/B testing to improve engagement and campaign performance.
- [Abandoned cart tutorial](https://documentation.onesignal.com/docs/en/abandoned-cart.md): Recover lost sales with abandoned cart notifications using OneSignal by tracking cart activity, building targeted segments, and sending timely reminders with Journeys.
- [Action buttons for push notifications](https://documentation.onesignal.com/docs/en/action-buttons.md): Add interactive action buttons to your push notifications on iOS, Android, and the web. Learn setup via Dashboard & API, supported platforms, click handling, icons, and event tracking.
- [Tags](https://documentation.onesignal.com/docs/en/add-user-data-tags.md): Use OneSignal Tags to store user properties and track events for advanced segmentation and personalized messaging.
- [Adobe Audience Manager](https://documentation.onesignal.com/docs/en/adobe-audience-manager.md): Learn how to integrate OneSignal with Adobe Audience Manager to sync audience segments and behavioral data, enabling targeted, multi-channel messaging campaigns that drive engagement, conversions, and revenue growth.
- [AI message composer](https://documentation.onesignal.com/docs/en/ai-message-composer.md): Use OneSignal's built in AI to write and adjust push notifications to suit your needs and send the right message quickly and easily
- [Aliases](https://documentation.onesignal.com/docs/en/aliases.md): Learn how to use custom aliases in OneSignal to identify and track users across different platforms and devices using your own unique identifiers. Aliases help unify user data across multiple sources and are essential for integrations, user data management, and transactional messaging.
- [AlloyDB](https://documentation.onesignal.com/docs/en/alloydb.md): Sync custom events from Google AlloyDB to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Amazon Athena](https://documentation.onesignal.com/docs/en/amazon-athena.md): Sync custom events from Amazon Athena to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Amazon Redshift](https://documentation.onesignal.com/docs/en/amazon-redshift.md): Sync custom events from Amazon Redshift to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Amazon SDK setup](https://documentation.onesignal.com/docs/en/amazon-sdk-setup.md): Step-by-step guide to integrate the OneSignal SDK into your Amazon Fire OS app for push notifications and in-app messaging capabilities.
- [Amplitude](https://documentation.onesignal.com/docs/en/amplitude.md): Integrate OneSignal with Amplitude to sync behavioral cohorts, track message events, and target Users across push, email, SMS, and in-app channels.
- [Metrics glossary](https://documentation.onesignal.com/docs/en/analytics-metrics-glossary.md): Understand the nuances between metric labels for each message channel across the OneSignal ecosystem to accurately interpret messaging performance.
- [Analytics overview](https://documentation.onesignal.com/docs/en/analytics-overview.md): Measure message performance, user engagement, and conversions in OneSignal. Covers dashboards, attribution models, trends, and data export.
- [Android Firebase credentials](https://documentation.onesignal.com/docs/en/android-firebase-credentials.md): Learn how to generate and configure Firebase Cloud Messaging (FCM) Service Account credentials for OneSignal to send Android push notifications to apps on the Google Play Store.
- [Android live notifications](https://documentation.onesignal.com/docs/en/android-live-notifications.md): Create and update dynamic, real-time notifications on Android devices using OneSignal Live Notifications. Deliver continuously updated content inside a single notification, simulating iOS Live Activities for Android.
- [Android notification categories](https://documentation.onesignal.com/docs/en/android-notification-categories.md): Set up Android notification categories (channels) in OneSignal to improve user control and customization of push notifications.
- [Android SDK setup](https://documentation.onesignal.com/docs/en/android-sdk-setup.md): Add push notifications and in-app messages to your Android app using OneSignal's Android SDK.
- [Angular Web SDK setup](https://documentation.onesignal.com/docs/en/angular-setup.md): Integrate OneSignal Web Push Notifications into your Angular application using the onesignal-ngx package. Learn how to install, configure, and troubleshoot service workers to deliver seamless push notifications.
- [iOS: App Clip Support](https://documentation.onesignal.com/docs/en/app-clip-support.md): Learn how to enable and configure OneSignal push notifications in iOS App Clips. Covers setup steps, limitations, and support for advanced experiences like Target-Content-ID.
- [Target outdated app versions to encourage app updates](https://documentation.onesignal.com/docs/en/app-version-update.md): Use in-app messages to detect outdated app versions and prompt users to update, with platform-specific segments for iOS and Android.
- [Apple App Privacy Requirements](https://documentation.onesignal.com/docs/en/apple-app-privacy-requirements.md): Understand how to accurately disclose your use of OneSignal in your iOS app to comply with Apple's App Privacy requirements. Learn which data types OneSignal collects and how to report them in App Store Connect.
- [Apps, Organizations, & Accounts](https://documentation.onesignal.com/docs/en/apps-organizations.md): Add, rename, move, and delete OneSignal apps and organizations. Understand the relationship between accounts, apps, and organizations.
- [Audit Logs](https://documentation.onesignal.com/docs/en/audit-logs.md): Track and review user activity across your OneSignal organization for security, compliance, and accountability. Export to JSONL or query via the REST API.
- [Huawei authorization](https://documentation.onesignal.com/docs/en/authorize-onesignal-to-send-huawei-push.md): Step-by-step guide to connect your Huawei app to OneSignal for push notifications, including PushKit setup, API key configuration, and Huawei's optional message self-classification for apps with users in China.
- [Track topic interest for smarter targeting](https://documentation.onesignal.com/docs/en/auto-segment-users-by-page-visit.md): Learn how to automatically track page visits by topic and use custom tags to send highly relevant Web Push notifications with OneSignal.
- [Track web push subscriptions by page topic](https://documentation.onesignal.com/docs/en/auto-segment-users-by-subscription-page.md): Tag web push subscribers based on the page they opted in from, then use those tags to create segments and trigger targeted campaigns.
- [Azure Synapse](https://documentation.onesignal.com/docs/en/azure-synapse.md): Sync custom events from Azure Synapse to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Badges](https://documentation.onesignal.com/docs/en/badges.md): Manage app icon badge counts for push notifications on iOS, Android, and Huawei, including auto-clearing, API control, and native badge logic.
- [Google BigQuery](https://documentation.onesignal.com/docs/en/bigquery.md): Export messaging event data to BigQuery and import custom events from BigQuery to trigger personalized campaigns.
- [Usage & billing](https://documentation.onesignal.com/docs/en/billing-faq.md): OneSignal billing overview covering invoices, payment methods, plan changes, usage metrics, and cost management for all plan types.
- [BlueConic](https://documentation.onesignal.com/docs/en/blueconic.md): Sync data from BlueConic to OneSignal
- [Booking confirmations](https://documentation.onesignal.com/docs/en/booking-confirmations.md): Use custom events, Journeys, and Data Feeds to send booking confirmation or recovery emails based on real-time booking status.
- [Web push browser behavior](https://documentation.onesignal.com/docs/en/browser-behavior-and-unsubscribes.md): Learn how to unsubscribe from notifications and understand how browsers handle web push subscriptions.
- [Building an Integration with OneSignal: Partner Guide](https://documentation.onesignal.com/docs/en/building-an-integration-with-onesignal-partner-guide.md): Everything you need to know about building your own OneSignal integration
- [Getting a Debug Log](https://documentation.onesignal.com/docs/en/capturing-a-debug-log.md): Learn how to capture detailed debug logs from your mobile app using the OneSignal SDK. This guide walks through enabling verbose logging, reproducing issues, and sharing logs for troubleshooting push notification issues across Android and iOS platforms.
- [Channel setup](https://documentation.onesignal.com/docs/en/channel-setup.md): Set up push notifications, in-app messages, email, SMS, RCS, and Live Activities in OneSignal to reach Users across every channel.
- [Clearing cache and resetting push permissions](https://documentation.onesignal.com/docs/en/clearing-cache-and-resetting-push-permissions.md): Learn how to reset browser push permissions, service workers, and site data across Chrome, Firefox, and Safari to ensure clean test environments and resolve web push notification issues.
- [ClickHouse](https://documentation.onesignal.com/docs/en/clickhouse.md): Sync custom events from ClickHouse to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Confirmed delivery](https://documentation.onesignal.com/docs/en/confirmed-delivery.md): Confirmed Delivery tracks when a device receives a push notification sent through OneSignal. Covers requirements, platform limitations, and troubleshooting for iOS, Android, Huawei, and Web.
- [Confluent Cloud](https://documentation.onesignal.com/docs/en/confluent-cloud.md): Sync custom events from Confluent Cloud to OneSignal to trigger automated Journeys and personalized messaging campaigns based on real-time user behavior.
- [Conversion metrics](https://documentation.onesignal.com/docs/en/conversion-metrics.md): Track the business impact of your messaging by attributing conversions like purchases and sign-ups to push, email, SMS, in-app, and RCS messages.
- [Create activity feed](https://documentation.onesignal.com/docs/en/create-an-activity-feed.md): Learn how to build an in-app activity feed using OneSignal's REST API, Event Streams, or on-device logic to track and display user notification history.
- [Create a custom email unsubscribe page](https://documentation.onesignal.com/docs/en/create-custom-unsubscribe-page.md): Learn how to replace OneSignal's default unsubscribe link with a branded, multi-language, and personalized email preferences page, while maintaining compliance and tracking.
- [Cross-platform Live Activity SDK setup](https://documentation.onesignal.com/docs/en/cross-platform-live-activity-setup.md): Learn how to implement Live Activities in OneSignal's Wrapper SDKs like React Native, Flutter, Unity, Cordova, and more, with support for Push To Start and Default Live Activity Type.
- [Custom events](https://documentation.onesignal.com/docs/en/custom-events.md): Track user behavior with Custom Events and use them to trigger Journeys, control flow with Wait Until steps, and personalize messages in real time.
- [Custom Outcomes](https://documentation.onesignal.com/docs/en/custom-outcomes.md): Learn how to track user actions and revenue from push notifications and in-app messages using OneSignal Custom Outcomes. Customize attribution and measure engagement with flexible outcome types across platforms.
- [Data collected by the OneSignal SDK](https://documentation.onesignal.com/docs/en/data-collected-by-the-onesignal-sdk.md): Data fields the OneSignal SDK collects automatically, with user permission, or manually — and how to control collection for privacy compliance.
- [Data feeds](https://documentation.onesignal.com/docs/en/data-feeds.md): Pull real-time data from your APIs into OneSignal email messages at send time using Data Feeds, with Liquid syntax for personalization.
- [Data & background notifications](https://documentation.onesignal.com/docs/en/data-notifications.md): Send silent push notifications to sync data or trigger background tasks on iOS and Android without displaying a visible message.
- [Data collection & security FAQs](https://documentation.onesignal.com/docs/en/data-questions.md): Learn how OneSignal protects your data, maintains compliance, and supports privacy regulations.
- [Data warehouse, DMP, & CRM integration](https://documentation.onesignal.com/docs/en/database-dmp-crm-integration.md): Integrate your CRM, database, or DMP with OneSignal to trigger personalized, real-time notifications and sync user messaging data at scale.
- [Databricks](https://documentation.onesignal.com/docs/en/databricks.md): Export OneSignal message events to Databricks and import Databricks behavioral events into OneSignal to trigger Journeys and personalize messaging.
- [Deep linking](https://documentation.onesignal.com/docs/en/deep-linking.md): Send users from OneSignal push, in-app, email, and SMS messages to a specific screen in your Android or iOS app using Universal Links, App Links, or custom URI schemes.
- [Delete users](https://documentation.onesignal.com/docs/en/delete-users.md): Delete users and subscriptions in OneSignal via the Dashboard or API for privacy compliance, cleanup, or bulk removal of inactive data.
- [Design emails with drag-and-drop](https://documentation.onesignal.com/docs/en/design-emails-with-drag-and-drop.md): Build responsive emails visually with OneSignal’s Drag and Drop Email Builder — settings, rows, content blocks, personalization, and compliance links.
- [Design emails with HTML](https://documentation.onesignal.com/docs/en/design-emails-with-html.md): Send fully custom branded emails using OneSignal's HTML Editor. Covers supported HTML rules, inline CSS, dark mode, unsubscribe handling, and client limitations.
- [Design in-app messages with drag-and-drop](https://documentation.onesignal.com/docs/en/design-your-in-app-message.md): Use OneSignal's visual composer to build high-converting in-app messages with blocks, layouts, carousels, and personalization.
- [Design in-app messages with HTML](https://documentation.onesignal.com/docs/en/design-your-in-app-message-with-html.md): Design and customize in‑app messages using OneSignal's HTML Editor for maximum flexibility, responsiveness, and branding.
- [Developers](https://documentation.onesignal.com/docs/en/developers.md): Developer guide to integrating OneSignal: SDK setup, API reference, User identity, and testing across mobile and web.
- [Mobile SDK Mapping](https://documentation.onesignal.com/docs/en/device-user-model-mobile-sdk-mapping.md): Compare method and property names between OneSignal's legacy Player Model (v3 & v4) and the modern User Model (v5+), with side-by-side Swift code examples for easier migration.
- [Web SDK Mapping](https://documentation.onesignal.com/docs/en/device-user-model-web-sdk-mapping.md): Compare OneSignal Web SDK methods between the legacy Player Model and the new User Model. Learn how to migrate your implementation with TypeScript-based code examples and updated method references.
- [Disabled apps & organizations](https://documentation.onesignal.com/docs/en/disabled-apps.md): Understand why your OneSignal app or organization may be disabled, what functionality is affected, and how to restore access or prevent future disablements.
- [Set up confirmed opt-in for email](https://documentation.onesignal.com/docs/en/double-opt-in-email.md): Learn how to implement a double opt-in (confirmed opt-in) process in OneSignal using Tags, Segments, and Journeys to improve engagement, compliance, and list quality.
- [Duplicated notifications](https://documentation.onesignal.com/docs/en/duplicated-notifications.md): Troubleshoot duplicate push notifications caused by SDK conflicts, server-side retries, multi-app environments, and platform-specific bugs.
- [Dynamic Content with CSV](https://documentation.onesignal.com/docs/en/dynamic-content.md): Personalize push, email, and SMS messages at scale using Dynamic Content with CSV uploads and Liquid syntax in OneSignal.
- [Elasticsearch](https://documentation.onesignal.com/docs/en/elasticsearch.md): Sync custom events from Elasticsearch to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Email address validation](https://documentation.onesignal.com/docs/en/email-address-validation.md): Validate email addresses during CSV import and in bulk to reduce bounces and protect your sender reputation.
- [Email regulatory compliance](https://documentation.onesignal.com/docs/en/email-compliance.md): Learn how to comply with global privacy and communication regulations when sending marketing emails using OneSignal. This guide covers consent requirements, opt-out rules, and email content regulations across major regions, including the EU, US, Canada, and more.
- [Email deliverability](https://documentation.onesignal.com/docs/en/email-deliverability.md): Improve inbox placement by managing sender reputation, reducing bounces and spam complaints, and following email hygiene best practices.
- [Email DNS configuration](https://documentation.onesignal.com/docs/en/email-dns-configuration.md): Manually add DNS records (SPF, DKIM, DMARC, CNAME, MX) to authenticate your sending domain for OneSignal email delivery.
- [Email message reports](https://documentation.onesignal.com/docs/en/email-message-reports.md): Track email delivery, opens, clicks, bounces, suppressions, and spam reports in OneSignal email message reports.
- [Email overview](https://documentation.onesignal.com/docs/en/email-messaging.md): Send marketing and transactional emails with OneSignal using the dashboard, Journeys, or the API — with built-in personalization, analytics, and deliverability tools.
- [Email reputation best practices](https://documentation.onesignal.com/docs/en/email-reputation-best-practices.md): Build and maintain a healthy email sending reputation to improve deliverability and avoid spam complaints.
- [Email setup](https://documentation.onesignal.com/docs/en/email-setup.md): Set up OneSignal Email by selecting a provider, creating a sender, configuring DNS authentication, and verifying your account.
- [Email template forwarding](https://documentation.onesignal.com/docs/en/email-template-forwarding.md): Forward your email templates to create them quickly!
- [Email troubleshooting](https://documentation.onesignal.com/docs/en/email-troubleshooting.md): How to diagnose and fix common OneSignal email issues.
- [Email warm up guide](https://documentation.onesignal.com/docs/en/email-warm-up.md): Warm-up ensures inbox providers trust your email sends. Learn how to gradually increase volume while maintaining high engagement and low complaint rates.
- [Engagement trends](https://documentation.onesignal.com/docs/en/engagement-analytics.md): Track user engagement across push, in-app, email, SMS, and Live Activities with the Engagement Trends chart in OneSignal. View delivery, click-through, and unsubscribe rates, and export to CSV.
- [EU-US Data Privacy Framework](https://documentation.onesignal.com/docs/en/eu-us-data-privacy-framework.md)
- [Event Streams](https://documentation.onesignal.com/docs/en/event-streams.md): Send message data out of OneSignal in real-time to your chosen destination.
- [Event Stream data reference](https://documentation.onesignal.com/docs/en/event-streams-data.md): Schema reference for all event, message, user, and subscription properties available in Event Streams and Webhooks, with Liquid syntax for each field.
- [Get more app store reviews](https://documentation.onesignal.com/docs/en/example-app-store-review.md): Prompt users to review your app using OneSignal in-app messages with native iOS and Android review prompts, reducing friction and increasing ratings.
- [Create a survey to ask for feedback](https://documentation.onesignal.com/docs/en/example-create-a-survey.md): Build a multi-page in-app survey using Carousel, Button Click Actions, Outcomes, and Tags for analytics and segmentation.
- [Onboard users with banner in-app messages](https://documentation.onesignal.com/docs/en/example-create-a-tutorial.md): Guide users with contextual top and bottom banner in-app messages that don't block your app UI.
- [Personalize in-app messages](https://documentation.onesignal.com/docs/en/example-tag-substitution.md): Target users based on their Tags with tag substitution
- [Target certain Android manufacturers and devices](https://documentation.onesignal.com/docs/en/example-target-certain-android-manufacturers-and-devices.md): Identify and target Android devices from manufacturers known to block push notifications when apps are swiped away, and use in-app messages to educate users on enabling proper settings.
- [Send verification, magic link, OTP, and double opt-in messages](https://documentation.onesignal.com/docs/en/example-verification-magic-link-otp.md): Examples of email and SMS verification messages using OneSignal, including one-time passwords, magic links, and double opt-in flows with templates and API examples.
- [Exporting data](https://documentation.onesignal.com/docs/en/exporting-data.md): Learn how to export user, message, and outcome data from the OneSignal dashboard and API, including CSV delivery reports, subscription data, and per-user message event activity.
- [FCM expired token FAQ](https://documentation.onesignal.com/docs/en/fcm-expired-token-faq.md): Why Android and Chrome push subscriptions get unsubscribed due to FCM token expiry, Google spam suppression, and how to troubleshoot unsubscribe spikes.
- [Financial / fintech industry](https://documentation.onesignal.com/docs/en/financial-fintech-industry.md): Messaging and strategic best practices tailored for the financial / fintech industry.
- [Test subscriptions](https://documentation.onesignal.com/docs/en/find-set-test-subscriptions.md): Find your device's subscription record and mark it as a test subscription in OneSignal for easier message testing across push, email, and SMS.
- [Flutter SDK setup](https://documentation.onesignal.com/docs/en/flutter-sdk-setup.md): Instructions for adding the OneSignal Flutter SDK to your Flutter app for iOS and Android
- [Flutterflow SDK setup](https://documentation.onesignal.com/docs/en/flutterflow-sdk-setup.md): Instructions for adding the OneSignal Flutter SDK to your Flutterflow app for iOS and Android
- [Push frequency capping](https://documentation.onesignal.com/docs/en/frequency-capping.md): Limit how often push notifications are sent
- [Gaming industry](https://documentation.onesignal.com/docs/en/gaming-industry.md): An overview of messaging and strategic best practices specific to the gaming industry.
- [GDPR & Individual Rights](https://documentation.onesignal.com/docs/en/gdpr-compliance.md): OneSignal provides the following solutions to help be GDPR compliant.
- [Amazon API key generation](https://documentation.onesignal.com/docs/en/generate-an-amazon-api-key.md): Step-by-step guide
- [Goals](https://documentation.onesignal.com/docs/en/goals.md): Define a success metric and target value on any message or Journey, then track progress on the delivery report.
- [Google Cloud SQL](https://documentation.onesignal.com/docs/en/google-cloud-sql.md): Sync custom events from Google Cloud SQL to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Google Play Data Safety Requirements](https://documentation.onesignal.com/docs/en/google-play-data-safety-requirements.md): Learn how to accurately complete the Google Play Data Safety form when using OneSignal. Understand what data is collected, how to disclose it, and ensure compliance with Google's privacy policies.
- [Google Postmaster Tools](https://documentation.onesignal.com/docs/en/google-postmaster-tools.md): Set up Google Postmaster Tools to monitor Gmail spam rates and domain reputation — data Gmail does not share directly with email senders.
- [Pub/Sub](https://documentation.onesignal.com/docs/en/google-pubsub.md): Sync custom events from Google Pub/Sub to OneSignal to trigger automated Journeys and personalized messaging campaigns based on real-time user behavior.
- [Google Sheets](https://documentation.onesignal.com/docs/en/google-sheets.md): Sync custom events from Google Sheets to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Google Sheets integration with Event Streams](https://documentation.onesignal.com/docs/en/google-sheets-integration-with-event-streams.md): This guide illustrates the required steps to setup a connection between OneSignal’s Event Webhooks to a custom Google Sheets document to analyze message events generated by OneSignal.
- [Google Tag Manager setup](https://documentation.onesignal.com/docs/en/google-tag-manager.md): Add OneSignal Web Push to your website using Google Tag Manager (GTM), including service worker setup, initialization, and sending Tags safely.
- [Greenplum](https://documentation.onesignal.com/docs/en/greenplum.md): Sync custom events from Greenplum to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Handling personal data](https://documentation.onesignal.com/docs/en/handling-personal-data.md): How OneSignal handles personal data and how you can meet GDPR, CCPA, and privacy requirements.
- [HIPAA](https://documentation.onesignal.com/docs/en/hipaa.md): Overview of OneSignal’s HIPAA compliance, including BAAs for enterprise customers.
- [OneSignal Documentation](https://documentation.onesignal.com/docs/en/home.md): Start building faster with OneSignal. Explore quickstarts, SDKs, messaging channels, API references, and advanced features like Journeys and Live Activities.
- [Huawei SDK setup](https://documentation.onesignal.com/docs/en/huawei-sdk-setup.md): OneSignal Huawei SDK Setup Guide for Android Studio.
- [HubSpot](https://documentation.onesignal.com/docs/en/hubspot.md): Automate push notifications, emails, SMS, and in-app messaging from HubSpot Workflows using the native OneSignal integration.
- [In-app click actions](https://documentation.onesignal.com/docs/en/iam-click-actions.md): Configure click actions on in-app message elements to open URLs, prompt for push or location permissions, track outcomes, tag users, or trigger custom logic.
- [In-app message event streams](https://documentation.onesignal.com/docs/en/iam-event-streams.md): How to utilize event streams to capture in-app message metrics
- [In-app triggers](https://documentation.onesignal.com/docs/en/iam-triggers.md): Options for displaying in-app messages to users.
- [Identity verification](https://documentation.onesignal.com/docs/en/identity-verification.md): Prevent user impersonation by requiring server-generated JWTs to verify External User IDs, email, and SMS subscriptions sent to OneSignal.
- [Import](https://documentation.onesignal.com/docs/en/import.md): Import or update users in OneSignal using CSV uploads, REST API, or manual entry. Supports email, SMS, tags, and more for seamless user onboarding or migration.
- [In-app message templates & quickstarts](https://documentation.onesignal.com/docs/en/in-app-html-templates.md): OneSignal quickstart designs and copy/paste HTML templates for In-App Messages, plus required setup and common gotchas.
- [In-app message JavaScript API reference](https://documentation.onesignal.com/docs/en/in-app-message-api.md): JavaScript methods for interactive HTML in-app messages in OneSignal.
- [In-app message reports](https://documentation.onesignal.com/docs/en/in-app-message-reports.md): OneSignal In-App Message delivery and statistics
- [In-app troubleshooting](https://documentation.onesignal.com/docs/en/in-app-message-troubleshooting.md): Common questions and troubleshooting steps about in-app messages.
- [In-app overview](https://documentation.onesignal.com/docs/en/in-app-messages-setup.md): Display targeted, customizable messages inside your mobile app to drive engagement, collect feedback, and prompt actions like push opt-in.
- [Build a button-driven onboarding carousel](https://documentation.onesignal.com/docs/en/in-app-onboarding-carousel-tutorial.md): Create a multi-step onboarding flow using HTML In-App Messages with button navigation and automatic dismissal.
- [Integrations overview](https://documentation.onesignal.com/docs/en/integrations.md): Connect OneSignal to third-party platforms, sync data with analytics tools, and automate messaging workflows.
- [Ionic/Cordova/Capacitor SDK setup](https://documentation.onesignal.com/docs/en/ionic-capacitor-cordova-sdk-setup.md): Instructions for adding the OneSignal SDK to your Ionic or Capacitor app for iOS, Android, Amazon Fire apps
- [iOS: Focus modes and interruption levels](https://documentation.onesignal.com/docs/en/ios-focus-modes-and-interruption-levels.md): Understanding device settings and how they interact with push
- [iOS: Image Carousel Push Notifications](https://documentation.onesignal.com/docs/en/ios-image-carousel-push-notifications.md): How to implement an image carousel in OneSignal iOS push notifications using Swift.
- [iOS p12 certificate generation](https://documentation.onesignal.com/docs/en/ios-p12-generate-certificates.md): Generate and upload a .p12 push certificate to connect your iOS or macOS app to Apple Push Notification service (APNs) through OneSignal.
- [iOS p8 token-based connection to APNs](https://documentation.onesignal.com/docs/en/ios-p8-token-based-connection-to-apns.md): Set up a .p8 authentication key to connect your iOS or macOS app to Apple Push Notification service (APNs) through OneSignal.
- [iOS provisional push notifications](https://documentation.onesignal.com/docs/en/ios-provisional-push-notifications.md): Provisional push notifications on iOS let your app send notifications without an upfront permission prompt, but with reduced visibility.
- [iOS: Relevance score](https://documentation.onesignal.com/docs/en/ios-relevance-score.md): How you can set a relevance score
- [iOS SDK setup](https://documentation.onesignal.com/docs/en/ios-sdk-setup.md): Add push notifications and in-app messages to your iOS app using OneSignal's iOS SDK.
- [ISO 27001](https://documentation.onesignal.com/docs/en/iso27001.md): Details on ISO 27001
- [Journey actions](https://documentation.onesignal.com/docs/en/journeys-actions.md): Define wait periods, branch journeys based on user behavior, and tag users using journey steps.
- [Journey analytics](https://documentation.onesignal.com/docs/en/journeys-analytics.md): Track Journey performance with delivery metrics, user activity, and conversion insights across push, email, SMS, and in-app channels.
- [Journey examples](https://documentation.onesignal.com/docs/en/journeys-examples.md): Step-by-step Journey configurations for onboarding, re-engagement, abandoned cart, A/B testing, recurring sends, and event-driven workflows.
- [Journey messages](https://documentation.onesignal.com/docs/en/journeys-messages.md): Configure push notification, email, SMS, and in-app message steps in a Journey, including templates, delivery timing, and session requirements.
- [Journeys overview](https://documentation.onesignal.com/docs/en/journeys-overview.md): Automated multichannel messaging flows that send email, push, SMS, and in-app messages based on user behavior, time delays, or profile attributes.
- [Journey settings](https://documentation.onesignal.com/docs/en/journeys-settings.md): Configure your Journey including who enters, exits, re-enters, and when it starts or stops.
- [Journey webhooks](https://documentation.onesignal.com/docs/en/journeys-webhook.md): Send HTTP requests from Journey steps to external servers, personalized with user data via Liquid syntax, with retry logic and debugging tools.
- [Apache Kafka](https://documentation.onesignal.com/docs/en/kafka.md): Sync custom events from Apache Kafka topics to OneSignal to trigger automated Journeys and personalized messaging campaigns based on real-time user behavior.
- [Keys & IDs](https://documentation.onesignal.com/docs/en/keys-and-ids.md): Find and manage your OneSignal App ID, Organization ID, and API keys. Learn how to create, rotate, secure, and migrate keys safely.
- [SMS keywords](https://documentation.onesignal.com/docs/en/keywords.md): SMS Keywords in OneSignal enable two-way engagement through auto-replies, user tagging, and segmentation based on subscriber responses.
- [Labels](https://documentation.onesignal.com/docs/en/labels.md): Organize and manage messages across push, email, SMS, and in-app channels with Labels in OneSignal. Easily filter, categorize, and streamline your campaign workflow.
- [URLs, links, & deep links](https://documentation.onesignal.com/docs/en/links.md): Set up launch URLs, deep links, dynamic URLs, UTM tracking, and click tracking across push, email, in-app, SMS, and RCS messages.
- [Live Activities](https://documentation.onesignal.com/docs/en/live-activities.md): Deliver real-time updates to the iOS Lock Screen and Dynamic Island with OneSignal Live Activities. Use for time-bound events like delivery tracking, sports scores, ride status, and live game updates.
- [Live Activities analytics](https://documentation.onesignal.com/docs/en/live-activities-analytics.md): Measure delivery, confirmed receipt, clicks, and unsubscribes for iOS Live Activities with OneSignal. Covers Key metrics, individual message reports, Audience Activity, and CSV export.
- [Live Activities developer setup](https://documentation.onesignal.com/docs/en/live-activities-developer-setup.md): Set up iOS Live Activities with OneSignal to display real-time updates on the lock screen and Dynamic Island.
- [Request location permissions with in-app messages](https://documentation.onesignal.com/docs/en/location-opt-in-prompt.md): Guide users to enable location tracking in your mobile app using a soft pre-prompt in OneSignal before triggering the native Android or iOS location permission request.
- [Location-based messages](https://documentation.onesignal.com/docs/en/location-triggered-event.md): Segment users by country, GPS coordinates, or geofence and send location-triggered push notifications with OneSignal.
- [macOS app setup](https://documentation.onesignal.com/docs/en/macos-app-setup.md): Learn how to integrate OneSignal into your macOS app, whether using Mac Catalyst or direct API access. Step-by-step guidance for configuring platforms and sending push notifications.
- [Team members](https://documentation.onesignal.com/docs/en/manage-team-members.md): Manage OneSignal user access by adding, removing, or updating team member roles at the app or organization level. Learn role permissions and plan availability.
- [Managing journeys](https://documentation.onesignal.com/docs/en/managing-journeys.md): Edit Journey steps and messages, view stats, duplicate or archive flows, delete Journeys, and add team notes for collaboration.
- [Materialize](https://documentation.onesignal.com/docs/en/materialize.md): Sync custom events from Materialize to OneSignal to trigger automated Journeys and personalized messaging campaigns based on real-time user behavior.
- [Personalization](https://documentation.onesignal.com/docs/en/message-personalization.md): Choose the right personalization method in OneSignal. Compare Properties, Custom Events, API custom_data, Data Feeds, and CSV uploads to send dynamic messages using Liquid syntax.
- [Microsoft Fabric](https://documentation.onesignal.com/docs/en/microsoft-fabric.md): Sync custom events from Microsoft Fabric to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Migrating to OneSignal](https://documentation.onesignal.com/docs/en/migrating-to-onesignal.md): Migrate to OneSignal from another messaging provider with SDK integration, user import, phased rollout, and testing guidance.
- [Mixpanel](https://documentation.onesignal.com/docs/en/mixpanel.md): Integrate OneSignal with Mixpanel to sync behavioral cohorts, track message events, and target Users across push, email, SMS, and in-app channels.
- [Mobile push setup](https://documentation.onesignal.com/docs/en/mobile-push-setup.md): End-to-end checklist for setting up mobile push notifications with OneSignal across iOS, Android, Huawei, and Amazon.
- [Mobile SDK reference](https://documentation.onesignal.com/docs/en/mobile-sdk-reference.md): Comprehensive API reference for the OneSignal Mobile SDK, including initialization, user identity, subscriptions, tags, permissions, in-app messages, live activities, and more. Supports Android, iOS, Unity, React Native, Flutter, and Cordova/Ionic platforms.
- [Mobile SDK setup](https://documentation.onesignal.com/docs/en/mobile-sdk-setup.md): Set up the OneSignal SDK for Android, iOS, Huawei, and cross-platform frameworks like React Native, Flutter, and Unity.
- [Mobile SDK troubleshooting](https://documentation.onesignal.com/docs/en/mobile-troubleshooting.md): Resolve common OneSignal Mobile SDK issues including push delivery failures, APNS errors, and in-app messaging problems across iOS, Android, and cross-platform frameworks.
- [OneSignal MCP Server (Beta)](https://documentation.onesignal.com/docs/en/model-context-protocol.md): OneSignal MCP Server connects AI assistants to your OneSignal app so you can manage users, segments, templates, messaging, and exports with natural-language prompts.
- [MotherDuck](https://documentation.onesignal.com/docs/en/motherduck.md): Sync custom events from MotherDuck to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Multi-language messaging](https://documentation.onesignal.com/docs/en/multi-language-messaging.md): Send personalized messages in multiple languages across push, email, and in-app messaging using OneSignal's dashboard or API.
- [MySQL](https://documentation.onesignal.com/docs/en/mysql.md): Sync custom events from MySQL to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [.NET MAUI SDK setup](https://documentation.onesignal.com/docs/en/net-sdk-setup.md): Instructions for adding OneSignal .NET SDK to your cross-platform MAUI app for iOS, Android, and Desktop.
- [News and media industry](https://documentation.onesignal.com/docs/en/news-and-media-industry.md): An overview of messaging and strategic best practices specific to the news and media industry.
- [Notification click-through rate (CTR)](https://documentation.onesignal.com/docs/en/notification-ctr.md): Troubleshoot and improve push notification click-through rate (CTR) in OneSignal. Covers how CTR is calculated, common causes of drops, reporting methodology, and tactics to improve engagement.
- [Notification icons](https://documentation.onesignal.com/docs/en/notification-icons.md): Push notification icon requirements, sizes, and best practices for Web Push, Android, and iOS, including how to configure default and per-message icons in OneSignal.
- [Notification Images Not Showing](https://documentation.onesignal.com/docs/en/notification-images-not-showing.md): Notifications images not appearing.
- [Notification sounds](https://documentation.onesignal.com/docs/en/notification-sounds.md): Add custom notification sounds to iOS, Android, Huawei, and Amazon apps — including file formats, SDK setup, and API parameters.
- [Web push: Notifications not shown](https://documentation.onesignal.com/docs/en/notifications-not-shown-web-push.md): Troubleshoot web push notifications that show as Delivered in OneSignal but don't appear on a subscriber's device.
- [Mobile push: Notifications not shown or delayed](https://documentation.onesignal.com/docs/en/notifications-show-successful-but-are-not-being-shown.md): Troubleshoot mobile push notifications that show as Delivered in OneSignal but don't appear or are delayed on Android and iOS devices.
- [OneSignal service worker](https://documentation.onesignal.com/docs/en/onesignal-service-worker.md): Set up and configure the OneSignalSDKWorker.js file so your website can receive and display web push notifications through OneSignal.
- [OSNotification payload](https://documentation.onesignal.com/docs/en/osnotification-payload.md): Reference for OneSignal's OSNotification object, including all payload fields, Android and iOS-specific properties, custom data, and click actions.
- [Web permission prompts](https://documentation.onesignal.com/docs/en/permission-requests.md): Configure OneSignal's web push permission prompts to maximize opt-ins. Covers slidedown prompts, native browser prompts, category selection, email/phone collection, subscription bell, and custom link prompts.
- [Personalize messages with API custom_data](https://documentation.onesignal.com/docs/en/personalization-api-custom-data.md): Send dynamic, message-specific data through the Create Message API using custom_data. Reference values in templates with Liquid syntax for real-time personalization.
- [Personalize with Custom Events](https://documentation.onesignal.com/docs/en/personalization-custom-event.md): Use Custom Event properties to personalize Journey messages with Liquid syntax. Learn how events are stored, accessed, and rendered in push, email, and SMS templates.
- [Personalize with properties](https://documentation.onesignal.com/docs/en/personalization-properties-and-tags.md): Personalize OneSignal messages using predefined properties and custom Tags. Access user, subscription, journey, message, template, and app-level data with Liquid syntax across email, push, SMS, and webhooks.
- [PostgreSQL](https://documentation.onesignal.com/docs/en/postgresql.md): Sync custom events from PostgreSQL to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Preference center](https://documentation.onesignal.com/docs/en/preference-center.md): Learn how to implement a custom user preference center in your app or website using OneSignal APIs to manage notification topics, frequencies, channels, and data privacy settings.
- [Prompt for push permissions](https://documentation.onesignal.com/docs/en/prompt-for-push-permissions.md): Ask users for push notification permission at the right moment using in-app soft prompts and the native system prompt on iOS and Android.
- [Push overview](https://documentation.onesignal.com/docs/en/push.md): Send and manage mobile and web push notifications with OneSignal using the dashboard or API, with targeting, personalization, and scheduling.
- [Fallback messages: Ensuring delivery across channels](https://documentation.onesignal.com/docs/en/push-fallback-method.md): Implement a fallback strategy with OneSignal to ensure critical messages are delivered via email or SMS when push notifications fail. Learn how to set up cross-channel messaging using Journeys, APIs, and segmentation for reliable user engagement.
- [Push message reports](https://documentation.onesignal.com/docs/en/push-notification-message-reports.md): Push message reports show delivery outcomes, confirmed receipt, failure diagnostics, click-through rates, and per-subscription audience activity for each push send.
- [Quickstart guide](https://documentation.onesignal.com/docs/en/quickstart-guide.md): Set up your OneSignal account, configure messaging channels, manage Users, and send your first message.
- [Rich Communication Services (RCS)](https://documentation.onesignal.com/docs/en/rcs-messaging.md): OneSignal RCS enables branded, interactive messaging with rich media, read receipts, and automatic SMS fallback.
- [ReactJS & NextJS Setup](https://documentation.onesignal.com/docs/en/react-js-setup.md): Learn how to integrate OneSignal push notifications with your ReactJS or NextJS web application, including initialization, service worker setup, and TypeScript support.
- [Expo SDK setup](https://documentation.onesignal.com/docs/en/react-native-expo-sdk-setup.md): Integrate the OneSignal Expo SDK into your iOS and Android apps using Expo SDK 52+ and EAS Build for push notifications and in-app messages.
- [React Native SDK setup](https://documentation.onesignal.com/docs/en/react-native-sdk-setup.md): Comprehensive guide to integrate the OneSignal React Native SDK for iOS, Android, and Amazon app platforms. Includes prerequisites, configuration steps, platform-specific setup, and troubleshooting common issues.
- [Retargeting messages](https://documentation.onesignal.com/docs/en/retargeting.md): Send follow-up push messages in OneSignal based on how Subscriptions interacted with a previous send — clicked, didn't click, failed delivery, or unsubscribed. Retargeting is available from any push message report within 30 days of the original send.
- [RevenueCat](https://documentation.onesignal.com/docs/en/revenuecat.md): Sync in-app purchase and subscription data from RevenueCat to OneSignal for personalized messaging.
- [Notification images & rich media](https://documentation.onesignal.com/docs/en/rich-media.md): Learn how to add images, gifs, and multimedia to mobile push notifications using OneSignal's Dashboard and API, including recommended formats, device-specific behavior, and rich media customization options.
- [Amazon S3](https://documentation.onesignal.com/docs/en/s3.md): Sync custom events from Amazon S3 CSV files to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Tag users with notification data](https://documentation.onesignal.com/docs/en/segment-based-on-notification-clicks.md): Track and segment users based on notification clicks and topics using OneSignal Tags.
- [Segment (Twilio)](https://documentation.onesignal.com/docs/en/segment-onesignal-integration.md): Integrate OneSignal with Twilio Segment for user data and messaging events.
- [Segments](https://documentation.onesignal.com/docs/en/segmentation.md): Create and manage dynamic user segments in OneSignal to target personalized messaging based on activity, location, tags, and more.
- [Senders](https://documentation.onesignal.com/docs/en/senders.md): Learn how to manage sender identities and domains to improve email deliverability and maintain a strong sender reputation.
- [Send WhatsApp Messages via Journey Webhooks](https://documentation.onesignal.com/docs/en/sending-whatsapp-messages-via-journey-webhooks.md): Send WhatsApp messages automatically using OneSignal Journeys and webhooks.
- [Server SDK reference](https://documentation.onesignal.com/docs/en/server-sdk-reference.md): Install, configure, and use OneSignal server SDKs to send push notifications, emails, and SMS from your backend in Node.js, Python, Java, Go, PHP, Ruby, C#, and Rust.
- [Mobile service extensions](https://documentation.onesignal.com/docs/en/service-extensions.md): Intercept and customize push notifications before display on iOS and Android. Enable rich media, confirmed delivery, custom styling, and background data handling.
- [Transactional emails](https://documentation.onesignal.com/docs/en/setup-transactional-emails.md): Send transactional emails like purchase confirmations, password resets, and welcome messages through OneSignal with delivery, click, and open tracking.
- [Shopify](https://documentation.onesignal.com/docs/en/shopify.md): Connect Shopify to OneSignal through the Vendo integration for web push notifications, customer tags, commerce events, and behavioral targeting.
- [SingleStore](https://documentation.onesignal.com/docs/en/singlestore.md): Sync custom events from SingleStore to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [SMS consent keyword management](https://documentation.onesignal.com/docs/en/sms-consent-keyword-management.md): Configure SMS opt-in, opt-out, help, and resubscribe keywords in OneSignal to manage subscriptions and meet compliance requirements.
- [SMS FAQ](https://documentation.onesignal.com/docs/en/sms-faq.md): Troubleshooting, encoding, sender types, and compliance answers for OneSignal SMS and MMS messaging.
- [SMS message reports](https://documentation.onesignal.com/docs/en/sms-message-reports.md): View SMS delivery statistics, Audience Activity, and failure reasons in OneSignal. Map Twilio provider errors from exports to fixes.
- [SMS overview](https://documentation.onesignal.com/docs/en/sms-messaging.md): Send SMS and MMS messages with OneSignal using the dashboard, Journeys, or the API — with segmentation, personalization, and delivery analytics.
- [SMS opt-in and collection](https://documentation.onesignal.com/docs/en/sms-opt-in-and-collection.md): Build compliant SMS opt-in forms and collect phone numbers for marketing.
- [Toll-free / 10DLC / RCS registration requirements](https://documentation.onesignal.com/docs/en/sms-registration-requirements.md): Requirements for registering Toll-free, RCS and 10DLC SMS campaigns with Twilio.
- [SMS Regulatory Compliance](https://documentation.onesignal.com/docs/en/sms-regulatory-compliance.md): A guide to SMS regulatory compliance.
- [SMS/RCS setup](https://documentation.onesignal.com/docs/en/sms-setup.md): Configure your SMS/RCS provider, set a default sender number, send a test message, and add subscribers in OneSignal.
- [SMS Verify](https://documentation.onesignal.com/docs/en/sms-verify.md): Send SMS verification codes for two-factor authentication and security.
- [Snowflake](https://documentation.onesignal.com/docs/en/snowflake.md): Sync custom events from Snowflake to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [SOC 2 Type II](https://documentation.onesignal.com/docs/en/soc-2-type-ii.md): OneSignal's SOC 2 Type II compliance certification and security controls.
- [Social Activity](https://documentation.onesignal.com/docs/en/social-activity.md): Learn how to use OneSignal to send push notifications for social actions like likes, follows, and invites, as well as for user-to-user direct messages.
- [SQL Server](https://documentation.onesignal.com/docs/en/sql-server.md): Sync custom events from Microsoft SQL Server to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Single Sign-On (SSO)](https://documentation.onesignal.com/docs/en/sso.md): Configure SSO (SAML 2.0 or OIDC) for your OneSignal organization so team members authenticate through your identity provider.
- [Starburst Enterprise](https://documentation.onesignal.com/docs/en/starburst-enterprise.md): Sync custom events from Starburst Enterprise to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Starburst Galaxy](https://documentation.onesignal.com/docs/en/starburst-galaxy.md): Sync custom events from Starburst Galaxy to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Subscriptions](https://documentation.onesignal.com/docs/en/subscriptions.md): Manage Subscriptions across mobile push, web push, email, and SMS in OneSignal. Covers properties, statuses, and how to update or migrate them.
- [Suppressions](https://documentation.onesignal.com/docs/en/suppressions.md): Manage suppressed email addresses in OneSignal to maintain list hygiene, reduce bounces, and protect your sender reputation.
- [Template analytics](https://documentation.onesignal.com/docs/en/template-analytics.md): Review delivery statistics, engagement metrics, and audience activity for push, email, and SMS templates in OneSignal.
- [Templates](https://documentation.onesignal.com/docs/en/templates.md): Create, send, and track reusable templates for push notifications, email, and SMS in OneSignal with Liquid personalization and aggregate performance metrics.
- [Push throttling](https://documentation.onesignal.com/docs/en/throttling.md): Push throttling controls how fast OneSignal delivers push notifications, helping you manage server load and avoid performance issues during high-volume sends.
- [Tags: Time Operators](https://documentation.onesignal.com/docs/en/time-operators.md): Automate time-based messages using Time Elapsed operators with Tags that store Unix timestamps in seconds.
- [Transactional messages](https://documentation.onesignal.com/docs/en/transactional-messages.md): Learn how to send transactional messages like OTPs, billing updates, and reminders using OneSignal’s API with personalized data via push, email, or SMS.
- [Trino](https://documentation.onesignal.com/docs/en/trino.md): Sync custom events from Trino to OneSignal to trigger automated Journeys and personalized messaging campaigns based on user behavior.
- [Web SDK troubleshooting](https://documentation.onesignal.com/docs/en/troubleshooting-web-push.md): Troubleshoot OneSignal Web Push issues including service worker errors, origin mismatches, MIME types, and notifications not showing.
- [WordPress troubleshooting](https://documentation.onesignal.com/docs/en/troubleshooting-wordpress-web-push.md): Comprehensive guide for troubleshooting common setup issues with OneSignal Web Push Notifications on WordPress, including browser compatibility (Chrome, Firefox, Safari), plugin integration, and resolving CDN or caching conflicts.
- [Tutorials & use cases](https://documentation.onesignal.com/docs/en/tutorials.md): Explore step-by-step tutorials and best-practice examples to help you implement OneSignal features and boost engagement, retention, and revenue.
- [Unity SDK setup](https://documentation.onesignal.com/docs/en/unity-sdk-setup.md): Learn how to set up OneSignal's Unity SDK to easily add push notifications to your Unity apps for iOS, Android, Amazon, and Huawei. This guide covers Unity installation, platform configuration, and initialization.
- [Email unsubscribe links & headers](https://documentation.onesignal.com/docs/en/unsubscribe-links-email-subscriptions.md): Learn how to manage email unsubscribe behavior in OneSignal, including unsubscribe links, List-Unsubscribe headers, suppression rules, and resubscription workflows.
- [Update mobile SDKs](https://documentation.onesignal.com/docs/en/update-mobile-sdk.md): Why updating mobile SDKs matters, how to do it efficiently, and how to make it part of your workflow.
- [User model & migration guide](https://documentation.onesignal.com/docs/en/user-model-migration-guide.md): Learn how to migrate from OneSignal’s device-centric model to the new user-centric APIs and SDKs for more personalized, multi-channel engagement.
- [Users](https://documentation.onesignal.com/docs/en/users.md): How OneSignal Users, OneSignal IDs, and External IDs connect Subscriptions across channels and devices.
- [Using Liquid syntax](https://documentation.onesignal.com/docs/en/using-liquid-syntax.md): Personalize email, push, SMS, in-app, and Live Activity content with Liquid tags, filters, conditionals, and loops — powered by OneSignal data sources like tags, properties, custom data, and Data Feeds.
- [VoIP push notifications](https://documentation.onesignal.com/docs/en/voip-notifications.md): Send VoIP push notifications on iOS using OneSignal with PushKit token registration and a VoIP certificate, plus Android alternatives for call-style behavior.
- [Vue JS Web SDK setup](https://documentation.onesignal.com/docs/en/vue-js-setup.md): Integrate OneSignal Web Push Notifications into your Vue.js application using either the onesignal-vue or @onesignal/onesignal-vue3 plugin. Learn how to install, configure, and customize service workers for seamless push delivery.
- [watchOS & Wear OS Support](https://documentation.onesignal.com/docs/en/watchos-and-wear-os-support.md): Complete guide to implementing OneSignal push notifications for standalone Apple watchOS and Android Wear OS applications, including setup instructions and API integration.
- [Web SDK - Custom Code Setup](https://documentation.onesignal.com/docs/en/web-push-custom-code-setup.md): Complete guide for setting up OneSignal Web Push notifications using custom code integration. Configure JavaScript SDK, service workers, and Safari certificates for Chrome, Firefox, Safari, and other web browsers.
- [iOS web push setup](https://documentation.onesignal.com/docs/en/web-push-for-ios.md): Complete guide to enabling web push notifications on iOS and iPadOS devices, including manifest file setup, user onboarding strategies, and implementation best practices for Safari, Chrome, and Edge browsers.
- [Web push setup](https://documentation.onesignal.com/docs/en/web-push-setup.md): Set up web push notifications with OneSignal to re-engage Users across Chrome, Firefox, Safari, and Edge.
- [Web push FAQ](https://documentation.onesignal.com/docs/en/web-push-setup-faq.md): Complete guide to OneSignal Web Push Notifications setup, requirements, browser compatibility, domain changes, and troubleshooting common issues for developers and website owners.
- [Web SDK reference](https://documentation.onesignal.com/docs/en/web-sdk-reference.md): Complete API reference for OneSignal Web SDK v16 with initialization, user management, push notifications, slidedown prompts, and debugging methods. Learn how to implement web push notifications, manage user subscriptions, and integrate email/SMS features.
- [Web SDK setup](https://documentation.onesignal.com/docs/en/web-sdk-setup.md): Add OneSignal web push notifications to your website with the JavaScript SDK, service worker setup, and dashboard configuration.
- [Web push webhooks](https://documentation.onesignal.com/docs/en/webhooks.md): Set up HTTP webhooks to receive real-time notifications when users display, click, or dismiss web push notifications. Complete guide with examples for Chrome, Firefox, and Safari browser support.
- [Windows app setup](https://documentation.onesignal.com/docs/en/windows-app-setup.md): Complete guide for integrating OneSignal push notifications into your Universal Windows Platform (UWP) app using Windows Push Notification Service (WNS) and OneSignal's REST API
- [WordPress](https://documentation.onesignal.com/docs/en/wordpress.md): Complete setup and migration guide for OneSignal WordPress Web Push Plugin v3+. Configure push notifications, prompts, and segmentation through the OneSignal dashboard with streamlined setup process.
- [Add a player](https://documentation.onesignal.com/reference/add-a-device.md): POST `https://onesignal.com/api/v1/players`
- [Cancel message](https://documentation.onesignal.com/reference/cancel-message.md): Stop a scheduled or currently outgoing message.
- [Copy template to another app](https://documentation.onesignal.com/reference/copy-template-to-another-app.md): Create a duplicate of a template in another app. The new template will be completely separate from the original (including having a new template_id) but will be created with all the same content.
- [Create or update alias](https://documentation.onesignal.com/reference/create-alias.md): Create or update one or more user aliases when you already know an existing alias. This API performs an upsert on the user’s identity object—either adding new aliases or updating existing ones.
- [Create alias (by subscription)](https://documentation.onesignal.com/reference/create-alias-by-subscription.md): Create or update an alias for a user using a known subscription ID.
- [Create an app](https://documentation.onesignal.com/reference/create-an-app.md): Programmatically create a new OneSignal app via the REST API. This guide explains required fields, supported platform configurations (Web, Android, iOS), and how to properly authenticate using your Organization API key.
- [Create API key](https://documentation.onesignal.com/reference/create-api-key.md): Use the OneSignal API to create a new Rich Authentication Token (App API Key) for a specific app. This guide explains how to authenticate with the Organization API key and configure optional IP allowlists using CIDR notation.
- [Create custom events](https://documentation.onesignal.com/reference/create-custom-events.md): The Custom Events API allows you to record user events. Custom events can represent any action users take in your application, such as completing a purchase, viewing content, or achieving milestones.
- [Sending messages with the OneSignal API](https://documentation.onesignal.com/reference/create-message.md): Step-by-step guide to send push notifications, emails, SMS, and Live Activities using OneSignal’s API.
- [Create segment](https://documentation.onesignal.com/reference/create-segments.md): Programmatically create segments in your OneSignal app using flexible filters and targeting rules.
- [Create Subscription by alias](https://documentation.onesignal.com/reference/create-subscription.md): Use this API to attach a new subscription—such as email, SMS, or push notification—to an existing OneSignal user identified by an alias.
- [Create template](https://documentation.onesignal.com/reference/create-template.md): Create reusable message templates for push, email, and SMS channels. Templates can be accessed through both the dashboard and API using a `template_id`.
- [Create user](https://documentation.onesignal.com/reference/create-user.md): Create a new user or modify the subscriptions associated with an existing User.
- [Export subscriptions CSV](https://documentation.onesignal.com/reference/csv-export.md): Generate a GZip-compressed CSV export of your current subscription data using this API endpoint.
- [Remove alias](https://documentation.onesignal.com/reference/delete-alias.md): Remove a specific alias from a user.
- [Delete API key](https://documentation.onesignal.com/reference/delete-api-key.md): Delete a specific Rich Authentication Token (App API Key) for a OneSignal app. Requires your Organization API Key and the token's unique ID, not the token value itself.
- [Delete segment](https://documentation.onesignal.com/reference/delete-segments.md): Delete segments from OneSignal. Does not delete users or subscriptions.
- [Delete Subscription](https://documentation.onesignal.com/reference/delete-subscription.md): Delete a specific subscription by its subscription_id. This stops messages from being sent to that subscription but does not prevent future subscriptions with the same token.
- [Delete template](https://documentation.onesignal.com/reference/delete-template.md): Permanently delete a specific message template from your OneSignal app using its template ID. Templates used in Journeys must be removed from those Journeys before deletion.
- [Delete user](https://documentation.onesignal.com/reference/delete-user.md): Delete a user including all associated properties, subscriptions, and identity.
- [Delete player record](https://documentation.onesignal.com/reference/delete-user-record.md): delete https://onesignal.com/api/v1/players/{player_id}?app_id={app_id}
- [Edit player](https://documentation.onesignal.com/reference/edit-device.md): put https://onesignal.com/api/v1/players/{player_id}
- [Edit tags with external user id](https://documentation.onesignal.com/reference/edit-tags-with-external-user-id.md): put https://onesignal.com/api/v1/apps/{app_id}/users/{external_user_id}
- [Email](https://documentation.onesignal.com/reference/email.md): Send a message using the email channel.
- [Export audience activity CSV](https://documentation.onesignal.com/reference/export-csv-of-events.md): Export a compressed CSV report of audience-level delivery and engagement data for a specific message. This includes sent, delivered, clicked, failed, and unsubscribed events across Push, Email, and SMS channels.
- [View user identity](https://documentation.onesignal.com/reference/fetch-aliases.md): Retrieve all aliases associated with a user using a known alias, such as an `external_id`, `onesignal_id`, or a custom alias. This API helps you map back to a user’s full identity from any one piece of identifying information.
- [View user identity (by subscription)](https://documentation.onesignal.com/reference/fetch-identity-by-subscription.md): Retrieve all aliases linked to a user using a known `subscription_id`. This is useful when the user’s identity is unknown but you have access to one of their push, email, or SMS subscriptions.
- [Idempotent API requests](https://documentation.onesignal.com/reference/idempotent-notification-requests.md): Prevent duplicate messages or custom events when retrying API requests.
- [List audit logs](https://documentation.onesignal.com/reference/list-audit-logs.md): Retrieve a paginated, time-scoped list of audit log events for an organization. Requires an Enterprise plan. Supports filtering by app, action, actor, target, and IP address.
- [Message history](https://documentation.onesignal.com/reference/message-history.md): View which subscriptions received a particular message
- [Push notification](https://documentation.onesignal.com/reference/push-notification.md): Send a message using the push notification channel.
- [Rate limits and error handling](https://documentation.onesignal.com/reference/rate-limits.md): Understand OneSignal API and application rate limits, common errors, retry behavior, and how to safely recover from failures without sending duplicate messages or disabling your app.
- [REST API overview](https://documentation.onesignal.com/reference/rest-api-overview.md): Programmatic access to OneSignal messaging, user management, segments, and data exports over HTTPS with rate limiting and retry support.
- [Rotate API key](https://documentation.onesignal.com/reference/rotate-api-key.md): Rotate an existing App API Key (Rich Authentication Token) for a OneSignal app. Useful when a token is compromised or needs replacement without creating a new key from scratch.
- [SMS](https://documentation.onesignal.com/reference/sms.md): Send a message using the SMS channel.
- [Start Live Activity](https://documentation.onesignal.com/reference/start-live-activity.md): Remotely start a Live Activity on iOS devices via OneSignal's REST API. Define the activity type, target users, and send dynamic, updatable content directly to a Live Activity interface.
- [Transfer Subscription](https://documentation.onesignal.com/reference/transfer-subscription.md): Transfer a Subscription to a different user within the same OneSignal app. Useful for associating existing Subscriptions like push, email, or SMS with a new or updated user identity.
- [Unsubscribe email with token](https://documentation.onesignal.com/reference/unsubscribe-with-token.md): Unsubscribe an email address from future messages by calling this API from your custom unsubscribe page. Automatically disables the associated email subscription using a token-based approach.
- [Update an app](https://documentation.onesignal.com/reference/update-an-app.md): Use to update the name or push platform configuration of an existing app. This guide explains required parameters and platform-specific update rules
- [Update API key](https://documentation.onesignal.com/reference/update-api-key.md): Update a Rich Authentication Token (App API Key) for a OneSignal app. Modify the token's name or IP allowlist settings using your Organization API Key.
- [Update Live Activity](https://documentation.onesignal.com/reference/update-live-activity-api.md): Update or terminate running iOS Live Activities using OneSignal’s Live Activities API. This endpoint enables real-time content updates and activity termination, ensuring dynamic, context-aware user experiences.
- [Update segment](https://documentation.onesignal.com/reference/update-segment.md): Update an existing segment's name and/or filters. The name parameter is always required. When filters are provided, all existing filters are replaced with the new ones.
- [Update Subscription by ID](https://documentation.onesignal.com/reference/update-subscription.md): Update properties on an existing OneSignal subscription using its subscription_id. Commonly used to enable or disable a subscription when managing outside of the OneSignal SDK.
- [Update Subscription by token](https://documentation.onesignal.com/reference/update-subscription-by-token.md): Update properties on an existing Subscription using its token. Commonly used to enable or disable subscription status when managing outside of the OneSignal SDK.
- [Update template](https://documentation.onesignal.com/reference/update-template.md): Update existing OneSignal message templates for push, email, or SMS. Changes apply immediately across dashboard and API usage via the `template_id` reference.
- [Update user](https://documentation.onesignal.com/reference/update-user.md): Modify a user's properties.
- [View an app](https://documentation.onesignal.com/reference/view-an-app.md): View the details of a single OneSignal app
- [View API keys](https://documentation.onesignal.com/reference/view-api-keys.md): View the details of all of your current app API keys (Rich Authentication Token) for a single OneSignal app.
- [View apps](https://documentation.onesignal.com/reference/view-apps.md): Retrieve a list of all OneSignal apps associated with your account, including key app details like name, App ID, subscription counts, and timestamps. Useful for managing multiple apps through the OneSignal API.
- [View player](https://documentation.onesignal.com/reference/view-device.md): GET https://onesignal.com/api/v1/players/{player_id}
- [View players](https://documentation.onesignal.com/reference/view-devices.md): GET `https://onesignal.com/api/v1/players?app_id={app_id}&limit={limit}&offset={offset}`
- [View message](https://documentation.onesignal.com/reference/view-message.md): View the details of a single message and the Outcomes associated with it.
- [View messages](https://documentation.onesignal.com/reference/view-messages.md): View the details for a collection of messages.
- [View outcomes](https://documentation.onesignal.com/reference/view-outcomes.md): View and export push notification outcome metrics such as clicks, conversions, and custom events.
- [View segment](https://documentation.onesignal.com/reference/view-segment.md): Retrieve details for a single segment by its ID, including subscriber count and optionally segment metadata and filters.
- [View segments](https://documentation.onesignal.com/reference/view-segments.md): Retrieve a list of segments associated with a specific OneSignal app. Useful for programmatically accessing segment metadata such as name, creation date, and status.
- [View template](https://documentation.onesignal.com/reference/view-template.md): Retrieve the details of a specific message template in your OneSignal app using its template ID. This API returns the template content, target channel, and timestamps for creation and last update.
- [View templates](https://documentation.onesignal.com/reference/view-templates.md): Retrieve a paginated list of message templates from your OneSignal app. This endpoint returns summary information for each template, including ID, name, creation, and update timestamps.
- [View user](https://documentation.onesignal.com/reference/view-user.md): Retrieve a user including aliases, properties, and subscriptions.
- [Changelog](https://documentation.onesignal.com/release-notes/changelog.md): Learn about the latest updates to OneSignal.
- [SDK Releases](https://documentation.onesignal.com/release-notes/sdk-releases.md): View the latest OneSignal SDK releases and updates.

## OpenAPI Specs

- [openapi](https://documentation.onesignal.com/openapi.json)

## Optional

- [Blog](https://onesignal.com/blog)
- [GitHub](https://github.com/OneSignal)
- [YouTube](https://www.youtube.com/@onesignalofficial/playlists)
- [Blog](https://onesignal.com/blog)
- [GitHub](https://github.com/OneSignal)
- [YouTube](https://www.youtube.com/@onesignalofficial/playlists)
- [Blog](https://onesignal.com/blog)
- [GitHub](https://github.com/OneSignal)
- [YouTube](https://www.youtube.com/@onesignalofficial/playlists)
- [Blog](https://onesignal.com/blog)
- [GitHub](https://github.com/OneSignal)
- [YouTube](https://www.youtube.com/@onesignalofficial/playlists)
- [Blog](https://onesignal.com/blog)
- [GitHub](https://github.com/OneSignal)
- [YouTube](https://www.youtube.com/@onesignalofficial/playlists)
- [Blog](https://onesignal.com/blog)
- [GitHub](https://github.com/OneSignal)
- [YouTube](https://www.youtube.com/@onesignalofficial/playlists)
- [Blog](https://onesignal.com/blog)
- [GitHub](https://github.com/OneSignal)
- [YouTube](https://www.youtube.com/@onesignalofficial/playlists)
- [Blog](https://onesignal.com/blog)
- [GitHub](https://github.com/OneSignal)
- [YouTube](https://www.youtube.com/@onesignalofficial/playlists)