How do I create an ActiveCampaign API interface (with examples)?

Wiki (en)
, , , ,
1

ActiveCampaign Interfaces

An API interface with ActiveCampaign allows for fast and efficient processing of data from other systems or Excel sheets with the CRM package. An ActiveCampaign API interface saves a lot of time and prevents errors during repetitive actions.

ActiveCampaign has over 60 APIs, which are all accessible through Invantive SQL. With Invantive SQL the technique stays under the hood and you can focus on the functionality thanks to SQL statements that are real-time converted into read- and write actions on ActiveCampaign and over 70 other (cloud) platforms. No technical knowledge is required. You do however need to have knowledge of the business processes involved and know what you want to achieve.

Excel files are also often used as the source of an ActiveCampaign API interface. Most users can prepare an Excel-sheet much quicker than having to enter, for instance, contact persons or their events one-by-one with similar data each time. Both interactively through the Excel add-in Invantive Control for Excel with ActiveCampaign as en masse through Invantive Data Hub or Invantive Cloud, Excel files can be read.

How do I create an ActiveCampaign API interface?

When creating an API interface or multiple API interfaces between different systems where ActiveCampaign is also interfaced, ActiveCampaign forms one side of the API interface. For the other side of the API connection you can choose from over 70 platforms such as various Visma products, but also Chargebee, Exact Online, Teamleader, Twinfield or AFAS. For all these platforms too, the API interface can access any API: each API is predefined and tested, and immediately usable.

A searchable overview of the available ActiveCampaign tables based on the ActiveCampaign API Documentation can be found at:

The most commonly used tables for an ActiveCampaign interface are listed at Meest populaire ActiveCampaign tabellen voor 2022 (Dutch).

Complete examples of ActiveCampaign API interfaces.

For common combinations with an ActiveCampaign interface, scripts for API interfaces are already available. In case of doubt whether an ActiveCampaign API interface is already coded, the advice is to leave a comment below.

Some popular concrete examples of interfaces with ActiveCampaign with statements ready to run are:

Manual or fully automatic

Processing data with an ActiveCampaign API interface can be done in several ways: both manual and fully automatic are possible. In general, it is wiser to start with a manual ActiveCampaign interface if the processes and/or data have not been processed automatically before. If there are few problems one can interface fully automatic ActiveCampaign.

However, it is desirable to regularly check the status of a fully automatic interface. This can be done via emails from the interfaces or by reviewing the software’s processing report.

Retrieving Data from ActiveCampaign

Retrieving data from ActiveCampaign works immediately after logging into ActiveCampaign with username, password and verification code with for example:

select *
from   Contacts

This approach is the same on all products. This wapproach with select is besides for an ActiveCampaign interface also the same for the other different systems.

Exchanging the data with the interface between ActiveCampaign and the other platform can be done with the insert, update and delete statements, but the synchronization is even more convenient with synchronize. A synchronization example of synchronize can be read at Synchronize Exact Online with Visma.net Financials. At the end of the synchronize statement, two tables are synchronized in terms of content. The synchronize statement itself figures out swiftly which changes are needed and can be processed efficiently.

API Performance

The API of a cloud application is slower than exchanging data with a remote device. For ActiveCampaign it is wise to assume 250 ms per change. Often a speed gain can be achieved by also treating updates as an insert. ActiveCampaign will automatically convert this internally.

Integration of Power BI with ActiveCampaign

For Power BI there is a predefined interface that allows all 66 available tables to be imported into Power BI Desktop, Power BI Service and Power Query for Excel. This ActiveCampaign Power BI interface can be found at:

A step-by-step guide with videos for interfacing ActiveCampaign with Power BI can be found at:

Integrating Azure Data Factory with ActiveCampaign

For Azure Data Factory, there is a predefined interface for loading all 66 ActiveCampaign tables into Azure Data Factory. This ActiveCampaign Azure Data Factory interface can be found at:

A step-by-step guide for interfacing ActiveCampaign with Azure Data Factory can be found at:

ActiveCampaign API Status

An interface with ActiveCampaign requires a stable Internet connection, but the ActiveCampaign APIs can also suffer from failures, ranging from slow operation to just being completely unreachable. The status of the ActiveCampaign APIs can be found at:

The ActiveCampaign API status can also be consulted via the Invantive Status page.

Prevent Failures by ActiveCampaign API Changes

The API is constantly undergoing changes. This often leads to unexpected API failures. Sometimes the cause of an API failure is automatically solved after a few days because someone else complained. But sometimes it is necessary to contact ActiveCampaign API Support yourself. When using Invantive SQL this will normally rarely be necessary because for the most common problems solutions have already been implemented under the hood you acquaire from Invantive.

Security, Keys and Permissions

The ActiveCampaign API has a simple security model; the key used is system-wide and can be found in the screen at the path /app/settings/developer.

The key for adding events is also the same for all users and can be found at the path /app/settings/tracking.

Need help?

Do you need help? Please leave a question on the site https://forums.invantive.com or contact Invantive by phone or e-mail. Invantive can also configure the ActiveCampaign-interface for you based on the already available drivers.