Let's build something great together

When you build integrations with ActiveCampaign, you can have a positive impact on small businesses across the world. This is where you can find ActiveCampaign API documentation, SDKs, support, and a community of developers like you.

Get Started    

Getting Started

Join us on the journey to enable millions of businesses to personalize and orchestrate better customer experiences!

At ActiveCampaign, we’re building the next evolution of automation that will enable businesses to personalize the customer experience and win in the experience economy. We’re inviting developers to help us change the way businesses create amazing, one-to-one personalized experiences to deepen meaningful relationships with their customers.

Ready To Get Started?

Great! Here’s what you need to know:

Request a developer sandbox account if you haven’t already.
Your developer sandbox account is a scaled-down ActiveCampaign production account where you will be able to test your apps before releasing them to customers.

Navigate within your sandbox account to App Studio

App Studio is a self-serve portal for developers and SaaS companies interested in building apps on our platform. Through App Studio, you’ll be able to independently write and test code, submit code for review and release an approved app directly into the ecosystem

You’ll find App Studio by logging into your sandbox account, going to Apps from the left navigation menu, then finding App Studio in the sub-navigation.

Click ‘Build a New App’ and give it a name!

To start building, click ‘Build a New App’ and give it a name (you can always change this later)! The Create a New App form registers your App with ActiveCampaign. Click submit and you are ready to build!

Get ready to build from App Studio Home and enter some App Details.

Next, you’ll land on App Studio Home where you’ll see there are three simple steps to build an App. You’ll also see an App Details tab - here you can provide some additional information and assets with your app that we’ll need when you submit your app for review.

Step 1: Build your Application

Clicking ‘Start Building’ from App Studio Home will take you to the live editor. We’ll start you with a skeleton configuration. You’ll use this along with the documentation (found here!) to build your app. As you are building, we’ll automatically save your configuration. Upon Save, we’ll guide you to any validation errors - you’ll see them appear in your Configuration Toolbox to the right of the editor. You’ll need to resolve all validation errors before testing or submitting.

Test App in Sandbox

When you are ready with a valid app configuration, the ‘Test app in sandbox’ button will be enabled for you. This feature will open a new tab with your app loaded in your sandbox account. You’ll be able to test your app in ActiveCampaign, all while we are generating real-time logs which can be found back in your editor. You’ll use these logs to debug your configuration. Make any changes you need to your app configuration, save then re-upload to sandbox to test your changes. When you are satisfied with your App, you’ll submit for review.

Step 2: Submit App for Review

You can submit your app for review from App Studio Home or from the configuration toolbox. Our team will review your app, if we find any issues, we’ll reach out to you via email and help you fix them quickly and easily. You’ll be able to see your App’s progression through our review process from App Studio Home. If you’ve submitted your app for review but want to make a change to your configuration, you can Withdraw your app from review from App Studio Home then re-submit when you are ready.

Step 3: Publish Your App

We will notify you when our review is complete and you’ll be ready to do any additional testing and release your app. Clicking Release your App from App Studio Home will take you to the Version Management tab where you’ll be able to see all versions of your app. You have two options when releasing your app - 1) You can release your app privately which will make the app accessible to you and any users of your ActiveCamapign account or 2) You can release your app to the Marketplace, making it accessible to all ActiveCampaign customers. We will work with you to get your Marketplace listing ready for release.

We Are Here To Help!

You’ll find the documentation to build your app here. Within these tools, you’ll find:

  1. Overview: a brief summary of what makes up an App
  2. CX App Lifecycle : A visual representation of how ActiveCampaign will talk to your servers
  3. Configuration Walkthrough: A step-by-step guide through the configuration file and the UI elements associated with the configuration. Throughout the walkthrough, we also provide some helpful tips along the way to consider when building your app.
  4. Example Configuration: This is your framework for building your app's configuration - copy this configuration and use Configuration Walkthrough, Configuration Specification, Actions and Resource Commands to fill in your relevant information
  5. Configuration Specification: This document lays out the definition of each section of the configuration
  6. Actions: This is a deep dive into the Actions supported by the configuration file
  7. Commands: This is a deep dive into the Commands supported by the configuration file

Have more questions? Reach out to our team at [email protected] and we’d be happy to help you get started and answer your questions along the way!

Updated 10 days ago

Getting Started

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.