Integrating your platform with OneSignal unlocks powerful opportunities for mutual customers, driving enhanced user engagement and value. This guide outlines the benefits, integration options, and steps to successfully join our partner ecosystem.

Getting Started

To start developing your integration, simply create a free account at onesignal.com. If you'd like to join our partner program or require access to premium features for integration development and testing, please reach out through partners.onesignal.com or contact us via email at [email protected].

Benefits of Integrating with OneSignal

As a OneSignal partner, you'll gain valuable benefits aligned with your integration success and engagement:

• Visibility and Recognition: Showcase your integration through a verified listing in the OneSignal Partner Directory, with opportunities for increased exposure and "featured" listings as your partnership grows.
• Enhanced Collaboration: Participate in joint co-marketing activities, co-selling initiatives, and access comprehensive training to maximize integration adoption.
• Strategic Support: Gain direct access to our dedicated support and technical teams, with additional levels of support unlocked based on partnership milestones.
• Growth Opportunities: Access progressively advanced partner benefits such as dedicated documentation pages, enterprise sandbox accounts, and prioritized marketing opportunities as you expand your customer base and reach specific partnership milestones.

Common Integration Use Cases

Here are primary ways to integrate with OneSignal, each offering unique opportunities to enhance customer experience and drive mutual growth:

1. Trigger Notifications (Push, Email, SMS)

Allow customers to seamlessly manage notifications directly from your platform, enhancing customer engagement across multiple channels.

Push, Email, SMS Integration Documentation

2. Email Template Management

Facilitate streamlined email marketing by syncing and managing email templates within OneSignal.

Email Template API Documentation

3. User Creation and Management

Automate user onboarding by directly creating and managing users and devices in OneSignal, simplifying user management. It is important to understand how a User is defined within OneSignal, and the one-to-many relationship a User has with devices (defined as “subscriptions”). See our Guide to Understanding Users in OneSignal.\

Create User Documentation

Create Alias Documentation

4. Sync User Atrributes

Enable targeted messaging by syncing valuable user data (location, preferences, behavior) directly with OneSignal.

Update User Attributes Documentation

5. Capture Event Streams

Capture valuable real-time user engagement data (notifications, interactions, email opens) for enhanced analytics and actionable insights.

Event Stream Documentation

6. Platform Embedding

Offer seamless integration to your customers by embedding OneSignal directly within your platform, simplifying customer onboarding with unique App IDs.

Platform Embedding Documentation

Important Requirement: "OneSignal-Usage" Header

Include the OneSignal-Usage HTTP header in all API requests:

OneSignal-Usage: YourCompany | Partner Integration

Including this header helps OneSignal identify your integration clearly, streamlines support, and facilitates tracking mutual customer adoption and success. This is required to pass our Verification process. We appreciate your cooperation!

Verify Your Integration

Once your integration is ready, submit the following details to [email protected]:

• Sandbox account credentials for testing
• Brief overview of integration use cases
• Explanation of your approach using OneSignal APIs

Verification formally recognizes your integration on OneSignal's side, enabling full access to all the advantages of our Integration Partner Program.

We’re excited to collaborate and help your integration succeed!