Integrating With ActiveCampaign
Overview
ActiveMember360 provides an integration between your WordPress website and ActiveCampaign.
The integration and communication between ActiveCampaign and ActiveMember360 can be achieved using two methods, either by the ActiveCampaign API and/or by webhooks/REST Hooks.
These are the only methods supported by ActiveCampaign, so are used by all applications that integrate with ActiveCampaign.
ActiveMember360 must have a connection to the ActiveCampaign API to function. Similarly webhook support is also required.
API
API stands for Application Programming Interface.
ActiveMember360 uses the ActiveCampaign API for two purposes:
To provide ActiveCampaign with the latest data. For example, if a tag is added to the logged in user within WordPress ActiveMember360 requests using the API that a tag be added to the relevant contact in ActiveCampaign and receives as a response whether this operation was successful or not.
To pull data from ActiveCampaign for use within the WordPress site. For example, upon login ActiveMember360 requests from ActiveCampaign all data related to the contact email address associated with the user who has successfully logged in and receives all ActiveCampaign contact data as a response.
In both cases ActiveMember360 makes a request to ActiveCampaign API and will then receive a response.
So, think of an API request and response as the software equivalent of using telephone directory enquiries. You ask for a phone number for someone and the response by the operative provides that.
Connecting To The ActiveCampaign API
The process for connecting the ActiveCampaign API to WordPress/ActiveMember360 can be found in the following article:
Webhooks/REST Hooks
When using a webhook with ActiveCampaign no request is required in any event whether using ActiveMember360 or any other integration. A webhook just sends the data when it’s available. The webhook processing is triggered automatically from within ActiveCampaign.
In this case the data is pushed to the WordPress site running ActiveMember360 automatically by ActiveCampaign.
The webhook is a way for ActiveCampaign to provide ActiveMember360 with real-time information. A webhook delivers data as it happens, meaning the most current data is available immediately.
So, this is the equivalent of being sent a new phone directory automatically every time someone is added to the directory, or their details change.
ActiveMember360 could use the ActiveCampaign API to ensure it is always working with the current data. However, as ActiveMember360 has no way of knowing when data has changed within ActiveCampaign it does not know when to make an API request for the current data, meaning it would have to continually send API requests to ensure all was current. A very inefficient process.
This makes webhooks much more efficient for this purpose than continually sending API requests/polling.
When the webhook is executed it will make a HTTP request (typically a HTTP POST) to the ActiveMember360 WordPress site, and ActiveMember360 then updates the local contact data for immediate use.
ActiveCampaign has two methods for using webhooks:
REST Hooks are essentially webhooks with predefined triggers and/or conditions to automatically process the webhook (sometimes referred to as webhooks with subscriptions). This makes REST Hooks easier to configure for a user than webhooks. REST Hooks in most cases can be configured directly by an application without any user involvement.
Within ActiveCampaign REST Hooks are not named as such. They are the webhooks which are defined/listed in your ActiveCampaign application ActiveCampaign, Settings, Developer, Manage Webhooks. Within ActiveMember360 this method of using webhooks is referred to as Automatic Webhooks.
Webhooks can also be used from within the Condition and Workflow section of ActiveCampaign automations. These are always manually defined and are completely separate to REST Hooks(Automatic Webhooks). Within ActiveMember360 this method of using is referred to as Automation Webhooks.
Automatic Webhooks
Configuration of Automatic Webhooks (REST Hooks) within ActiveCampaign
Full details upon how to configure, use, and troubleshoot Automatic Webhooks (REST Hooks) for ActiveCampaign when using ActiveMember360 can be found in the following article:
By default ActiveMember360 uses Automatic Webhooks because no additonal configuration is required to ensure any changes to contact data within ActiveCampaign is immediately sent (pushed) to WordPress/ActiveMember360 whenever an ActiveCampaign contact is added or updated.
However the use of Automatic Webhooks in certain circumstances can have an adverse effect upon your server and website performance. In such cases Automation Webhooks should be used in preference.
Please refer to: Considerations When Using Automatic Webhooks
Automation Webhooks
Configuration Automation Webhooks within ActiveCampaign
The configuration of Automation Webhooks for ActiveCampaign can be found in the following article:
Specific details upon how to use Automation Webhooks when using ActiveMember360 can be found within:
Webhook Modules
ActiveMember360 provides several webhook modules(callbacks) for use with ActiveCampaign webhooks.
These are primarily for use with ActiveCampaign automation webhooks.
The webhook modules are detailed within Webhook Modules.
Custom Webhook Modules
ActiveMember360 also provides a framework for users to define their own webhook modules(callbacks) for use with ActiveCampaign webhooks.
These are primarily for use with ActiveCampaign automation webhooks.
These can be used to provide virtually unlimited capabilities regarding the ActiveCampaign contact record.
More details regarding custom webhook modules are provided within Webhook Custom Modules.