Send audience lists to ActiveCampaign

Note

This topic contains information about configuring a destination that sends query results to ActiveCampaign using orchestrations. To configure a destination that sends audiences to ActiveCampaign using campaigns see this topic .

ActiveCampaign is an automation platform for ecommerce, business-to-consumer, and business-to-business that helps you use email and SMS marketing to reach, nurture, convert, and grow your customer base.

Note

This destination uses the Active Campaign REST API .

Changes to audience lists are not immediately available in ActiveCampaign. Allow for up to 24 hours after the point at which Amperity has finished sending audience updates for them to be available.

ActiveCampaign API is rate limited to 5 requests per second.

Get details

Review the following details before configuring credentials for ActiveCampaign and before configuring Amperity to send audience lists to ActiveCampaign.

Detail 1.

Credential settings

API key

Required

The API key for your ActiveCampaign account.

Base URL

Required

The base URL for your ActiveCampaign account. For example: https://<your-account>.api-us1.com/api/3/.
Detail 2.

Required configuration settings

Audience primary key

The primary key for the audience. Set to “email”.

Group name

The name of the user group to which Amperity will send data. This group must exist in ActiveCampaign and must have permission to view and interact with the email list.

You must log into ActiveCampaign as a member of the specified user group to have access to the email list that is managed by Amperity.

List name (Required at orchestration)

The name of an email list in ActiveCampaign that will be managed by Amperity.
Detail 3.

A contact in ActiveCampaign is defined by an email address. A contact may have additional information, but cannot exist without an email address.

Use a query or a campaign to define the information in the email list that will be managed by Amperity.

Configure credentials

Configure credentials for ActiveCampaign before adding a destination.

An individual with access to ActiveCampaign should use SnapPass to securely share “API key” and “URL” details with the individual who will configure Amperity.

To configure credentials for ActiveCampaign

Step 1.

From the Settings page, select the Credentials tab, and then click the Add credential button.
Step 2.

In the Credentials settings dialog box, do the following:

From the Plugin dropdown, select ActiveCampaign.

Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination.
Step 3.

The settings that are available for a credential are determined by the credential type. For the “active-campaign” credential type, configure settings, and then click Save.

API key

Required

The API key for your ActiveCampaign account.

URL

Required

The base URL for your ActiveCampaign account. For example: https://<your-account>.api-us1.com/api/3/.

Add destination

Use a sandbox to configure a destination for ActiveCampaign. Before promoting your changes, send a test audience, and then verify the the results in ActiveCampaign. After the end-to-end workflow has been verified, push the destination from the sandbox to production.

To add a destination for ActiveCampaign

Step 1.

Open the Destinations page, and then click the Add destination button.

Add

To configure a destination for ActiveCampaign, do one of the following:

  1. Click the row in which ActiveCampaign is located. Destinations are listed alphabetically and you can scroll up and down the list.

  2. Search for ActiveCampaign. Start typing “acti”. The list will filter to show only matching destinations. Select “ActiveCampaign”.
Step 2.

Select the credential for ActiveCampaign from the Credential dropdown, and then click Continue.

Tip

Click the “Test connection” link on the “Configure destination” page to verify that Amperity can connect to ActiveCampaign.
Step 3.

In the “Destination settings” dialog box, assign the destination a name and description that ensures other users of Amperity can recognize when to use this destination.

Configure business user access

By default a destination is available to all users who have permission to view personally identifiable information (PII).

Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies.

Enable the PII setting checkbox to allow users with limited access to PII access to this destination.

Restricted PII access is enabled when the Restrict PII access policy option that prevents users who are assigned to that option from viewing data that is marked as PII anywhere in Amperity and from sending that data to any downstream workflow.
Step 4.

Configure the following settings, and then click “Save”.

Audience primary key

Required

The primary key for the audience. Set to “email”.

Group name

Required

The name of the user group to which Amperity will send data. This group must exist in ActiveCampaign and must have permission to view and interact with the email list.

You must log into ActiveCampaign as a member of the specified user group to have access to the email list that is managed by Amperity.

List name (Required at orchestration)

Required

The name of an email list in ActiveCampaign that will be managed by Amperity.

Verbose logging?

Enable verbose logging to return log details when ActiveCampaign rejects adding contacts to the email list.

When verbose logging setting is enabled, a list of rejected contacts is returned by the response from ActiveCampaign. For each rejected contact, a contact identifier is provided along with a string that describes the reason why the contact was rejected.
Step 5.

After this destination is configured:

  • Use orchestrations to send query results

  • Use orchestrations and campaigns to send audiences

  • Use orchestrations and campaigns to send offline events

Workflow actions

A workflow will occasionally show an error that describes what prevented a workflow from completing successfully. These first appear as alerts in the notifications pane. The alert describes the error, and then links to the Workflows tab.

Open the Workflows page to review a list of workflow actions, choose an action to resolve the workflow error, and then follow the steps that are shown.

Step one.

You may receive a notifications error for a configured ActiveCampaign destination. This appears as an alert in the notifications pane on the Destinations tab.

Review a notifications error.

If you receive a notification error, review the details, and then click the View Workflow link to open this notification error in the Workflows page.
Step two.

On the Workflows page, review the individual steps to determine which step(s) have errors that require your attention, and then click Show Resolutions to review the list of workflow actions that were generated for this error.

The Workflow page, showing a workflow with errors.
Step three.

A list of individual workflow actions are shown. Review the list to identify which action you should take.

Choose a workflow action from the list of actions.

Some workflow actions are common across workflows and will often be available, such as retrying a specific task within a workflow or restarting a workflow. These types of actions can often resolve an error.

In certain cases, actions are specific and are shown when certain conditions exist in your tenant. These types of actions typically must be resolved and may require steps that must be done upstream or downstream from your Amperity workflow.

Amperity provides a series of workflow actions that can help resolve specific issues that may arise with ActiveCampaign, including:
Step four.

Select a workflow action from the list of actions, and then review the steps for resolving that error.

Choose a workflow action from the list of actions.

After you have completed the steps in the workflow action, click Continue to rerun the workflow.

Invalid credentials

The credentials that are defined in Amperity are invalid.

To resolve this error, verify that the credentials required by this workflow are valid.

  1. Open the Credentials page.

  2. Review the details for the credentials used with this workflow. Update the credentials for ActiveCampaign if required.

  3. Return to the workflow action, and then click Resolve to retry this workflow.

Invalid group name

A user group defines which set of users within ActiveCampaign have permission to interact with contacts in a contact list. For example: managing tags, defining list exclusions, or running campaigns.

When the name of the user group defined in Amperity does not match the name of a user group defined in ActiveCampaign, Amperity will be unable to update the list of contacts for a contact list and a workflow action will be shown.

To resolve this error, verify the name of the user group in ActiveCampaign, and then update the data template in Amperity for the correct name of the user group.

  1. Log in to ActiveCampaign as a user assigned who is assigned to the Admin permission.

  2. Verify the name of the user group and/or create a user group with the name that is required by this workflow.

  3. Verify the name of the user group that is defined in the data template used by this workflow. Update this value if required.

  4. Return to the workflow action, and then click Resolve to retry.