Creating an extended integration for ActiveCampaign users

Let Oomnitza be your single source of truth!

You'll get visibility of your ActiveCampaign users as data from ActiveCampaign is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and ActiveCampaign in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key user information
• Configurable reports to share information about users with your colleagues and management
• Configurable workflows for: 
  • Ingesting all users from ActiveCampaign into Oomnitza's SaaS module
  • Reading a user's role assignment from ActiveCampaign
  • Deleting a user from ActiveCampaign
  • Creating new ActiveCampaign users
  • Getting and updating ActiveCampaign users

Navigation

Adding an ActiveCampaign global variable

Adding the credentials

Creating the user integration

Creating custom mappings

Creating workflows

Creating user workflows with the API block

Delete User

Create User

Get User Details

Update User Information

Creating Saas user workflows

User Role preset

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

ActiveCampaign uses Token based authentication. A username and a password are required to access the service. This is the API key that you can see via Settings > Developer > API Access > Key within ActiveCampaign. This integration uses version 3 of the ActiveCampaign API.

For further information consult the ActiveCampaign API documentation.

Adding an ActiveCampaign global variable

To save time when you create workflows, set your subdomain as a global variable:

1. Click Configuration > General > Global Settings.
2. Click Add new variable (+).
3. Add the ActiveCampaign.Subdomain variable and its value. The value is the name of your ActiveCampaign subdomain. If your ActiveCampaign URL is https://mycompany.activecampaign.comyour subdomain would be: mycompany.
4. Save your changes.

Adding the credentials

To stream ActiveCampaign user data into Oomnitza, complete the following steps:

1. Click Configuration > Security > Credentials, and then click Add new credential (+).
2. Add the information details.
3. On the AUTHORIZATION tab, complete these actions:
   • Ensure that API Key is selected.
   • Ensure that the token name is Api-Token.
4. Enter your API Key. 
5. Ensure that Add to Header is selected.
6. Click SAVE. 

Next

You use the credentials that you added to create and customize your ActiveCampaign integrations with Oomnitza.

Creating the user integration

Info and connect details

1. From the menu, click Configuration > Integrations .
2. Click Integrations List View .
3. On the Integrations page, scroll down to the Extended section for User Integrations.
4. Click NEW INTEGRATION.
5. In the New User Integration sidebar, click ActiveCampaign.
6. Click APPLY next to the ActiveCampaign User Load, and then click NEXT twice.

Connect page

Best practice
To ensure that only live user records are streamed to Oomnitza, choose Update only as your integration preference. When you run the integration, you can check the error logs to see which user records weren't uploaded and why they weren't uploaded. You can then decide whether to upload the user records that were skipped by changing your integration preference to create and upload. See Access error logs.

On the connect page, complete the following steps to connect the integration:

1. Enter a descriptive name for the integration such as ActiveCampaign User Load. This name will be displayed on the Integrations page once the setup is complete.
2. From the User Selection list, select User plus SaaS User or User only.
3. If you select User plus SaaS User and you have multiple instances of the same SaaS application, select the application from the SaaS Selection list. If you have a single instance of the SaaS application, skip this step.
4. From the installation type list, select Cloud.
5. From the Credentials list, select your credentials.
6. From the Integration Preferences list, select Update only.   
7. Enter the name of the user of the integration.
8. Your Subdomain should be derived from the variable created in Adding an ActiveCampaign global variable or entered manually. 
9. Click Next.

Creating custom mappings

Map the ActiveCampaign fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

1. Click Smart Mapping.
2. Create a custom mappings to map the ActiveCampaign Id to Oomnitza. 
   1. Click the down arrow on the Id field.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field to ActiveCampaign User Id.
   4. Click CREATE. 
3. You have the option to create custom mappings to map any other field that you want to add to Oomnitza. To create an optional custom mapping, do the following:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field.
   4. Click CREATE. 
4. Map and assign a sync key to the Email field.
5. Click NEXT.

Note
For all user loads, it is recommended that you map role information to an employee role in Oomnitza. Users need to have an employee role defined in order to access Oomnitza. If the role information is not available from the user load, it is recommended that you select Employee from the Oomnitza Role dropdown list. You have the option to overwrite this at a later point should the role information become available. 

Standard ActiveCampaign to Oomnitza mappings

The following ActiveCampaign fields can be mapped to Oomnitza:

Connect: Credentials
Connect: Subdomain
Connector Sync Time
Email
First Name
Id
Last Name
Phone
Signature
Username

Want to map more fields to Oomnitza?
Contact Support, or see Mapping extended connectors.

When you've completed mapping the ActiveCampaign to Oomnitza fields, click NEXT.

Schedule

By default, user data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Configure your schedule.
2. Click FINISH.

Result
A new tile is created for the integration on the Integrations page. 

What to do next

If you want to see the information that is collected now, click the tile on the Integrations page and click RUN NOW.

If you want to change the integration settings, you can click a navigation link on the page, such as 4 Mappings, and edit the settings. 

Creating workflows

Creating user workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create user workflows with the API block by following the steps in Creating user workflows with the API block.

To locate the available presets, enter ActiveCampaign in the Select Preset search field. Select your preset of choice and for every preset enter the following information in the Configure section:

1. Your correct ActiveCampaign Credentials that you created in Adding the credentials.
2. Your Subdomain should be derived from the variable created in Adding an ActiveCampaign global variable or entered manually. 

For information on the specific requirements for each preset, click one of the links below:

Delete User

Create User

Get User Details

Update User Information

Using the ActiveCampaign Delete User preset

The ActiveCampaign Delete User preset  preset allows you to delete a user from ActiveCampaign. You can use the Advanced Mode to configure the message payload. To do this, 

1. Click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. The ActiveCampaign user id is assumed to be stored in the {{activecampaign_user_id}} field that you created in Creating custom mappings. If you have not done this, you can replace the value {{activecampaign_user_id}} in the URL with the correct field or user id. 
3. Select the Response tab. You have the option to map the Response field {{response}} to a custom long text Oomnitza field. You can create a custom field by going to People>Customization. For further information, see Creating Custom Fields in Oomnitza.

For further information see ActiveCampaign API documentation: Delete user.

Using the ActiveCampaign Create User preset

The ActiveCampaign Create User preset preset allows you to create an ActiveCampaign user. When constructing a workflow that uses this preset, the following information is mandatory:

• New Username
• New FirstName
• New LastName
• New Email
• New Password
• GroupID. ID of the Group to which the user belongs. 
  

You have the option to use the Advanced Mode to configure the response as described in step 3 of Using the ActiveCampaign Delete User preset. For further information see ActiveCampaign API documentation: Create a user.

Using the ActiveCampaign Get User Details preset

The ActiveCampaign Get User Details preset preset allows you to get the details of an ActiveCampaign user. When constructing a workflow that uses this preset, the following information is mandatory:

• Map Response to Field. Unlike the presets above, the response field is mandatory and is required to be entered before using this preset. The field name should be in lower case, and spaces replaced with an underscore.

Use the Advanced Mode to configure the message payload. To do this, 

1. Click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. The ActiveCampaign user id is assumed to be stored in the {{activecampaign_user_id}} field that you created in Creating custom mappings. If you have not done this, you can replace the value {{activecampaign_user_id}} in the URL with the correct field or user id. 
3. Select the Response tab. You have the option to map the Jinja statement to an Oomnitza field. The Jinja statement returns the response in the same manner as the Map Response to Field, except in the form of a dict or array. This format may be preferable for troubleshooting. 

Additional resources:
ActiveCampaign API documentation: Retrieve User
Creating Custom Fields in Oomnitza
Importing and Using Libraries with Jinja2

Using the ActiveCampaign Update User Information preset

The ActiveCampaign Update User Information preset preset allows you to update the details of an ActiveCampaign user. When constructing a workflow that uses this preset, the following information is mandatory:

• First Name
• Last Name
• GroupID. ID of the Group to which the user belongs. 

Use the Advanced Mode to configure the message payload. To do this, 

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Body tab. Modify, update or add fields that will be used in the request payload. For information on the fields that are permitted in the request payload, see ActiveCampaign API documentation: Update a user
3. Select the Response tab. You have the option to map the Response field {{response}} to a custom long text Oomnitza field. You can create a custom field by going to People>Customization. For further information, see Creating Custom Fields in Oomnitza.
4. Select the Information tab.  The ActiveCampaign user id is assumed to be stored in the {{activecampaign_user_id}} field that you created in Creating custom mappings. If you have not done this, you can replace the value {{activecampaign_user_id}} in the URL with the correct field or user id. 

Creating Saas user workflows

You can create the SaaS User workflow by following the steps in Creating Saas user workflows. When creating the user workflows with the API block for ActiveCampaign, the following specific configuration is required:

To locate the available presets, enter ActiveCampaign in the Select Preset search field. Select your preset of choice and for every preset enter the following information in the Configure section:

1. Your correct ActiveCampaign Credentials that you created in Adding the credentials.
2. Your Subdomain should be derived from the variable created in Adding an ActiveCampaign global variable or entered manually. 

The ActiveCampaign SaaS User workflow block comes with one available preset, the ActiveCampaign User Role preset.

Using the ActiveCampaign User Role preset

The ActiveCampaign User Role preset enables you to read a user’s role and group information from ActiveCampaign. For further information see ActiveCampaign API documentation: List all users.

For further information on workflows see:
 Understanding workflows
 Workflow block overview

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your users, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started for more information.