Skip to main content
Install the OneSignal SDK and get your first integration working. Follow the sections in order for a first-time setup, or jump to the area you need.
  1. Get started: find your App ID and API keys
  2. Install SDK: install the Mobile or Web SDK
  3. Users and identity: identify Users, manage Subscriptions, and secure access
  4. Test your integration: verify delivery before going live

​
Get started

If your team already has a OneSignal account, ask an admin to invite you to the Organization. Otherwise, create an account to get started. Your OneSignal App holds user and message data, including the App ID and API keys you need for SDK setup. Learn how Apps, Organizations, and accounts relate if you manage multiple projects or environments.

Keys and IDs

Find your App ID, REST API key, and Organization ID for authentication.

​
Install SDK

Install the OneSignal SDK for your platform.

Mobile SDK setup

SDK setup for iOS, Android, Huawei, and Amazon. Enables push notifications, in-app messages, and Live Activities.

Web SDK setup

Web SDK installation and browser push notification setup.

​
Users and identity

OneSignal assigns each person a OneSignal ID and tracks their devices, email addresses, and phone numbers as Subscriptions. Users are anonymous until you call login with an External ID to identify them. Identifying Users unifies their Subscriptions across channels and devices.

Users

User model, External ID, anonymous vs. identified Users, and login/logout.

Subscriptions

Devices, email addresses, and phone numbers that receive your messages.

Tags

Add custom properties to users for personalization and segmentation.

Custom events

Track User actions to trigger Journeys or power analytics.

​
Test your integration

Verify delivery, rendering, and deep links with Test Users before sending to your full audience. If something fails, capture debug logs or check mobile and web troubleshooting.

Test Users

Find and configure test users for push, email, and SMS.

​
After setup

Explore common use cases and look up SDK methods or REST API endpoints as you build.

Tutorials & use cases

Browse implementation guides for abandoned carts, onboarding flows, re-engagement campaigns, and more.

Tags

Add custom properties to users for personalization and segmentation.

Custom events

Track User actions to trigger Journeys or power analytics.

Mobile SDK reference

Methods, classes, and event hooks for iOS, Android, and cross-platform SDKs.

Web SDK reference

Initialization, User management, Subscription methods, and custom triggers.

Server SDK reference

Install and configure server SDKs for Node.js, Python, Java, Go, PHP, Ruby, C#, and Rust.

REST API overview

Endpoints, authentication, rate limits, and request/response formats.

​
FAQ

​
How do I identify Users across devices?

Call OneSignal.login("your_external_id") on each device after the user signs in. OneSignal merges all Subscriptions with the same External ID under a single User. See Users for implementation details.

​
Do I need to set up identity verification?

Identity verification is optional but strongly recommended for production apps. Without it, any client can call login with an arbitrary External ID. Enabling identity verification requires updating the OneSignal SDK to use a server-generated JWT, preventing impersonation.

​
Can I use OneSignal without the Mobile or Web SDK?

Yes. You can send email and SMS, manage Users, and trigger messages with the REST API or a Server SDK. The Mobile and Web SDKs are required for push notifications, in-app messages, and client-side User identification.

​
How do I send messages from my server?

Use the REST API or a Server SDK. Authenticate with your REST API key from Keys & IDs. Never embed the REST API key in a mobile or web client.