If you are building an app that connects to Omnisend, follow the steps below to understand the API, choose an authentication method, complete your integration, and submit it for review.
💡 This article focuses on the partner journey. For implementation details, use the Omnisend API documentation.
Before You Begin
Define what your app will do with Omnisend data. For example, your app might:
Synchronize Contacts.
Retrieve Products.
Send Events that trigger Automation Workflows.
Omnisend is a self-service platform. You do not need to request a separate sandbox account for development or testing.
Create a regular Omnisend account and use test data while developing your integration. You can create an account through the standard Omnisend signup process.
Submission Process
Step 1. Review the Omnisend API Documentation
Start with Create your own app. This guide explains how Omnisend apps are structured and which steps are required.
Next, review the Quick Start Guide. It covers the API fundamentals you need for development, including authentication, endpoints, and request formats.
Identify the API resources your app needs:
Use the Contacts API if your app synchronizes contact data.
Use the Events API if your app sends events or triggers Automation Workflows.
Use the Event Tracking documentation if your integration needs website behavior data, such as page views, product views, or cart additions.
Before continuing, document:
What your app will send to Omnisend.
What your app will retrieve.
Which permissions it needs.
What should happen when a request fails.
Step 2. Choose an Authentication Method
Choose between an API key and OAuth based on how users will connect your app.
💡 For a public app that multiple merchants will connect to, Omnisend recommends OAuth. OAuth gives each user an authorization flow instead of requiring them to create and share an API key manually.
To implement OAuth, follow the OAuth authentication instructions. Then, submit the OAuth Credentials request form.
Provide the information requested in the form. Omnisend will provide the credentials and information you need to continue.
Step 3. Build and Test Your Integration
Build and test your integration with a regular Omnisend account. Use test data and review the results in Store settings → API logs. Use API Logs to debug requests and confirm that data is passing correctly.
Test the complete user experience, including:
Authorization.
Data synchronization.
Failed requests.
Disconnecting.
Reconnecting.
If your app sends contacts, orders, products, carts, or events, verify that each resource behaves as described in your App Market listing.
Step 4. Submit Your Completed App
After you implement and test your integration, complete the App Market submission form.
Include the information requested in the form, such as:
App name.
App description.
Category.
Website.
Logo.
Setup instructions.
Support contact.
Authentication method.
Requested permissions.
Testing information.
If the form requests screenshots, test credentials, privacy information, or security details, provide them with your submission. This helps Omnisend test your app.
Step 5. Understand the Review Process
After you submit the form, Omnisend reviews your integration and proposed App Market listing.
The review checks whether:
The app works as described.
The app uses the requested permissions appropriately.
The listing provides clear setup instructions.
Omnisend may contact you if information is missing or if your integration requires changes.
If changes are requested, update the app or listing according to the review team’s instructions.
After the integration passes review:
Omnisend can approve and publish the listing in the App Market. Users can then browse the listing and connect the app.
Omnisend also writes a dedicated support article explaining how merchants can integrate your app with Omnisend.
Step 6. Maintain Your App After Publication
Keep your integration up to date after publication. Review your permissions before releasing major changes, and keep your support contact information current.
If you plan to improve the integration, let Omnisend know so the related support content can be updated.
FAQ
Should I use an API key or OAuth?
Choose the authentication method based on how users will connect your app. OAuth is recommended for public apps that multiple users will use.
What information should I include in my App Market submission?
Provide the information requested in the submission form, including your app name, description, category, website, logo, setup instructions, support contact, authentication method, requested permissions, and testing information.
Need help with Omnisend? Contact our Support team through the in-app chat or email [email protected]. Our team is available 24/7.