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

About this task

This integration imports user records to the People page in Oomnitza.

Before you start

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

You will need the following for the Oomnitza integration:

API Key

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.

Subdomain

You will need to supply your Active Campaign subdomain in Oomnitza. If your ActiveCampaign URL is https://mycompany.activecampaign.comyour subdomain would be: mycompany.Your subdomain can be set as a global variable in Adding an ActiveCampaign global variable, or can be entered manually.

For further information consult the ActiveCampaign API documentation.

Adding an ActiveCampaign global variable

To save time when you create the user integration and 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. 
4. Save your changes.

Adding the credentials

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

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward button > to select the integration.
4. Add your API key.
5. Click Create.

Integration not in the list? Click Advanced Mode and complete these steps:

1. Add the information details.
2. On the AUTHORIZATION tab, complete these actions:
   • Ensure that API Key is selected.
   • Ensure that the token name is Api-Token.
3. Enter your API Key. 
4. Ensure that Add to Header is selected.
5. Click SAVE. 

Next

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

Creating the user integration

1. In Oomnitza, click Configuration > Integrations > Overview.
2. Click Block view .
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. In the sidebar, search for the integration.
6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

• User only. Add user records.
• User plus SaaS user. Add user and SaaS user records. 

The benefit of adding SaaS user records is that you can run a workflow to validate the status and activity of SaaS users and retrieve information such as the role of the SaaS user. The information that can be retrieved depends on whether SaaS user workflows are available for the integration. 

Installation types

• Cloud. Store credentials in the Oomnitza cloud.
• Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

• Create & Update. Add and update records.
• Create only. Add records.
• Update only. Update records.

Editing the integration details

1. Click Edit .
2. Make your changes.

Editing the credential details

If you selected Cloud as the installation type, choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

  Selecting Edit integration to add rules for syncing data. Filtering integration results.  
 

You can add new fields to your integration by selecting Add new field   on the mapping page. 
Creating custom API fields. 

Creating custom mappings

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

Complete these actions:

1. Click Smart Mapping to automatically detect appropriate mapping fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
2. Create a custom mapping 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. Select the Unique checkbox.
   5. Click CREATE. 
3. Ensure that the Username is mapped to the Username field on the Oomnitza side (required for integration).
4. Ensure that the Email is mapped to the Email field on the Oomnitza side (required for integration).
5. Select the Role field on the Oomnitza mapping side.
6. Choose a suitable role from the list (a defined role is necessary for the integration)
7. Map and assign a sync key to a unique field, such as the Email.
8. Click UPDATE.

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

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, see Running an extended integration

If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

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 Using 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 can map the Response field {{response}} to a custom long text Oomnitza field. To create a custom field, click Configuration > Data Model > Field Configuration, from the Objects list select Users, and then click Add. 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.
4. To create a custom field, click Configuration > Data Model > Field Configuration, from the Objects list select Users, and then click Add. See Creating Custom Fields in Oomnitza.
5. 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. 

Reference articles for workflows

• Mapping positive and negative responses
• Troubleshooting workflows 
• Using the API block

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.

Reference articles for creating workflows

• Creating SaaS user workflows.
• Offboarding SaaS users.

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, 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.