If you want to integrate Omnisend with another software (e.g., a third-party contact form), you can pass data to Omnisend (or get data) via our API. We require an API key for authorization purposes with every request.
In the article, you'll learn how to generate an API key in Omnisend.
Creating an API Key
Step 1. Go to Store Settings → API keys → click Create API key.
Step 2. Enter the name of your API key.
We suggest typing the name of the app you are trying to connect to. If it matches the name of the selected app, you will need to go through a short installation process and won't need to create the key manually.
Step 3. Select API key permissions.
If you were not moved to the app installation step after typing the app's name, proceed with the process and choose the permissions the key should have.
There are a few options you can check. The permissions allow access to the following data:
Campaigns (allows downloading reports, list of recipients);
Contacts (allows creating, editing, downloading, and deleting subscribers);
Orders (allows to create, edit, download, and delete orders);
Products (allows to create, edit, download, and delete products);
Carts (allows to create, edit, download, and delete carts);
Events (allows triggering and getting custom events for custom automation).
Permissions are created to ensure your API key only passes through the information you want and does not abuse your integration. You can create a different combination of the permissions, for example, a key that has access only to Contacts data and cannot reach Products or Campaigns.
These permissions are helpful when you're integrating Omnisend extensively into your store. See our documentation to learn more about API integration.
Step 4. Click Create API key → Copy AI key and use it for your integration.
💬 Learn more about the full Omnisend API documentation.
If you need help, remember that we are here for you 24/7 at [email protected] and in-app chat.