Apps focuses on automating event processing. As a developer, you will have the opportunity to define processing logic to allow data to flow to and from ActiveCampaign.
Apps offer developers capabilities to interact with contacts in ActiveCampaign. You can develop and publish integrations that can create or update contact information within an ActiveCampaign account (inbound), or send data changes from ActiveCampaign to a 3rd party platform (outbound).
A configuration file is composed of any number of workflows that specify how an integration should work. This page provides an overview of high-level concepts.
Applications that focus on Customer Experience Automation through workflows. Inside of ActiveCampaign, Apps will be able to declare affinity to different sections of our ecosystem to add value for our customers.
An event is triggered by a change that has taken place within ActiveCampaign or a 3rd party system.
“a contact was created”,
“a form was submitted”,
“the ticket status was changed”,
“a row was added to a worksheet”
To be used by an integration, these events should also include context about the event. For example, a "contact created" event should also contain the contact data.
An external resource is a collection of data or information that is stored in a 3rd party system. Typically, the information stored in a resource will be modified whenever a change takes place. Examples of resources are “contacts”, “forms”, “tickets”, “meetings”, etc.
Resources can have different types of changes made to them. For example, a contact can be created, updated, deleted, etc. A ticket can be created, experience a status change, have a description deleted from it, etc. Apps allows data associated with such changes to modify contact data within ActiveCampaign.
For inbound integrations, 3rd party platforms are required to send data via webhooks to ActiveCampaign when new events occur (contact data updates, new contact added, form submitted, etc.). The payload must be JSON and should represent the resource that had a change occur.
A REST endpoint is required to subscribe and unsubscribe to webhooks for specific resources. Apps will provide a custom URL for each resource subscribed to.
A JSON file that describes an integration. The configuration file has four different sections: auth, api, data_intake (inbound only) and workflows.
- The auth section defines how a user connects to an integration.
- The api section defines basic api functionality that a 3rd party provides such as pagination.
- The data_intake section defines how to setup and manage webhooks (supported now) or other event notification capabilities (coming in future releases) used by 3rd party APIs to send data (inbound) to ActiveCampaign.
- The workflows section details how users can set up the integration with a guided experience, and how events are processed.
A workflow performs a task through a sequence of steps. It is normally set up once and can automatically complete a task when triggered by an event ("do this when that happens")
"add new row in google sheets when a contact is created",
"create a contact when a form submission is received",
"update contact information in ActiveCampaign when an appointment is booked"
Updated 4 months ago