Create a Data Access Object for ActiveCampaign Data using JDBI

Ready to get started?

Download a free trial of the ActiveCampaign Driver to get started:

 Download Now

Learn more:

ActiveCampaign Icon ActiveCampaign JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with ActiveCampaign account data including Accounts, Contacts, Deals, and more!

A brief overview of creating a SQL Object API for ActiveCampaign data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for ActiveCampaign integrates connectivity to live ActiveCampaign data in Java applications. By pairing these technologies, you gain simple, programmatic access to ActiveCampaign data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write ActiveCampaign data.

Create a DAO for the ActiveCampaign Contacts Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyContactsDAO { //insert new data into ActiveCampaign @SqlUpdate("INSERT INTO Contacts (LastName, Email) values (:lastName, :email)") void insert(@Bind("lastName") String lastName, @Bind("email") String email); //request specific data from ActiveCampaign (String type is used for simplicity) @SqlQuery("SELECT Email FROM Contacts WHERE LastName = :lastName") String findEmailByLastName(@Bind("lastName") String lastName); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to ActiveCampaign

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to ActiveCampaign.

ActiveCampaign supports authenticating with the API Key. To connect to ActiveCampaign, set the following:

  • URL: This can be found in your account on the My Settings page under the Developer tab. For example: https://{yourAccountName}
  • APIKey: This can be found in your account on the Settings page under the Developer tab. Each user in your ActiveCampaign account has their own unique API key.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the ActiveCampaign JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.activecampaign.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for ActiveCampaign will typically look like the following:


Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:activecampaign:URL=yourUrl;APIKey=yourApiKey"); MyContactsDAO dao =; //do stuff with the DAO dao.close();

Read ActiveCampaign Data

With the connection open to ActiveCampaign, simply call the previously defined method to retrieve data from the Contacts entity in ActiveCampaign.

//disply the result of our 'find' method String email = dao.findEmailByLastName("Smith"); System.out.println(email);

Write ActiveCampaign Data

It is also simple to write data to ActiveCampaign, using the previously defined method.

//add a new entry to the Contacts entity dao.insert(newLastName, newEmail);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for ActiveCampaign by integrating with the CData JDBC Driver for ActiveCampaign. Download a free trial and work with live ActiveCampaign data in custom Java applications today.