Zapier lets you set up automated workflows across various external applications and platforms. Agillic has developed a native application for Zapier that lets you integrate workflows on Zapier with your Agillic instance. The workflows in Zapier are known as Zaps. The Agillic integration is developed and maintained by Agillic, and is currently in Beta.

This article covers the basic principles you need in order to set up and configure workflows using the Agillic integration on Zapier.

In this article you will find more information about:

• What does the Agillic integration on Zapier do?
• How to set up a Zap workflow using the Agillic integration
  • Choose Zap Trigger
• Select action to perform when Zap is triggered
  • Achieve Event
  • Update Recipient
  • Get Recipient
• Connect your Zap to your Agillic instance
  • Instance environment
  • Instance name
  • API Developer Key
  • API Developer Secret
• Configure your action step
  • Achieve Event
  • Update Recipient
  • Get Recipient
• Data formats
• Test your connection

In order to use the Agillic integration on Zapier, your organisation must have:

An Agillic instance, with a user who has:

• Access to create Agillic API Credentials
• Access to the Agillic Data module
• Access to the Agillic Flows module

A Zapier account:

• Note the rate limit enforced on your tier of Zapier license
• Note the retry logic of Zapier based on tier
• Note the notification emails set on Zapier

What does the Agillic integration on Zapier do?

The Agillic integration enables you to interact with your recipient data on your Agillic instance directly from Zapier. The Agillic integration can be added to any Zap and can both be used to retrieve data or push updated recipient data to your instance. The integration can be added to Zaps as many times as you need. This makes automatic retrieving, handling and updating of data across different external platforms and applications easy to configure and work with within Zaps.

The Agillic integration on Zapier lets you perform the following three actions on your Agillic instance directly from workflows in Zapier via Agillic’s Recipient API:

1. Achieve Event on your Agillic instance
2. Updates or Creates Recipient’s person data on your Agillic instance
3. Get a Recipient’s person data from your Agillic instance

How to set up a Zap workflow using the Agillic integration

In order to take advantage of the Agillic integration on Zapier you must first create a Zap workflow on Zapier. The Agillic integration is available as an “Action” step within a Zap.

Choose Zap Trigger

Before you can choose an action and work with the Agillic integration within your Zap, you must first choose a trigger to start your Zap. The Zap trigger is a preliminary event that triggers the action phase of the Zap, much like triggered flows in Agillic.

When a trigger is configured you can proceed to an “Action” step in your Zap.

Select action to perform when Zap is triggered

Search for “Agillic” in order to find the integration in the library of applications. Click the application to add it to your Zap as an Action. When the Agillic integration is added to the Action step in your Zap you will be able to choose what type of action is needed.

The integration supports the following three interactions with your Agillic instance:

Achieve Event

Achieves an event in Agillic for a recipient. The event achieved can have various side-effects, configured in your Agillic instance. The ‘Achieve Event’ action will send a POST request to the Agillic recipient API.

Update or Create Recipient

Updates or create a Recipient in your Agillic instance for the data fields present. If the Recipient does not exist with the unique identifier provided, one will be created. The ‘Update or Create Recipient’ action will send a PUT request to the Agillic recipient API.

Get Recipient

Gets all populated Person Data field values for the desired Recipient. The ‘Get Recipient’ action will send a GET request to the Agillic recipient API.

Connect your Zap to your Agillic instance

The next step is to select which Agillic account and environment (staging or production) you wish to connect your Zap to.

Instance environment

The “instance environment” refers to either staging or production. Please keep in mind that your data on staging will not be available on production and vice versa.

Instance name

The “instance name” refers to the actual URL of your Agillic instance. This is identical to the address you visit when accessing your instance environment in your browser.

API Developer Key

Enter the ‘developer key’ from a valid set of API credentials. Please note that since the Agillic integration accesses data from your instance via the Agillic Recipient API, a set of API credentials is needed in order to configure the integration. If you have not yet configured a set of API credentials on your instance, you will need to do this first in order to continue the integration with Zapier. Please note that API credentials in Agillic are separate for the staging and production environment. A set of API credentials configured on staging will not work on production and vice versa.

API Developer Secret

Enter the ‘Developer Secret’ that pairs with your ‘Developer Key’.

Configure your action step

Achieve Event

Unique Recipient Identifier Field
Select a unique identifier person data field for your recipients. In most cases it will make sense to choose the same person data field here as the one configured as Recipient ID on your Agillic instance.

Unique Recipient Identifier Value
Enter recipient identifier or select the unique recipient value from a previous action step.
This value corresponds with the person data field selected above.

Event Name
Choose the event to be triggered in Agillic for the recipient selected.

Update or Create Recipient

Unique Recipient Identifier Field
Select a unique identifier person data field for your recipients. In most cases it will make sense to choose the same person data field here as the one configured as Recipient ID on your Agillic instance.

Unique Recipient Identifier Value
Enter recipient identifier or select the unique recipient value from a previous action step.
This value corresponds with the person data field selected above.

Data Fields to update or create
Select the person data fields you wish to update and enter or insert the corresponding values in the input field below. Currently 10 updatable data fields are supported by the integration.

Get Recipient

Unique Recipient Identifier Field
Select a unique identifier person data field for your recipients. In most cases it will make sense to choose the same person data field here as the one configured as Recipient ID on your Agillic instance.

Unique Recipient Identifier Value
Enter recipient identifier or select the unique recipient value from a previous action step.
This value corresponds with the person data field selected above.

Data formats

Please be aware that all data input fields in your Zap are of type String. This means that the fields can contain any character and value in the Zapier UI. However, if you have selected to update a “timestamp” or “date” field in Agillic, it is important to match the specific format and syntax for that particular field type in your integration with the syntax and format defined in your Agillic instance. You can access and view the correct formats from the Settings panel in Agillic, under API Import settings.

Test your connection

For each action step configured a “Test and review” option is immediately available. This makes it possible to test that everything is configured correctly before you activate your Zap.

The “Test and review” option sends an API request directly to your instances with the information and data provided in the Zap. It is therefore recommended that you first configure and test the action step towards the staging environment to ensure that no test requests are executed to your live recipient data on production. Please keep in mind that API credentials are separate for staging and production environments.

In order to verify the connectivity from Zapier you will need to access your Agillic instance and look up your test recipient in a target group on staging. To view the latest activity data for your recipient you can mark your recipient from the target group list and then select the magnifying glass icon in order to access Recipient investigation.

If you have achieved an event for a recipient in your Zap, you will be able to see that the specific event has been achieved and the event counter has incremented.