Mailchimp Connector for UiPathRead / write MailChimp Campaigns, Lists, Members, Reports and more in without coding. In this article you will learn how to quickly and efficiently integrate Mailchimp data in UiPath without coding. We will use high-performance Mailchimp Connector to easily connect to Mailchimp and then access the data inside UiPath. Let's follow the steps below to see how we can accomplish that! Mailchimp Connector for UiPath is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Mailchimp in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Mailchimp using UiPath we first need to create a DSN (Data Source) which will access data from Mailchimp. We will later be able to read data using UiPath. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "Mailchimp" from the list of Popular Connectors. If "Mailchimp" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
MailchimpDSNMailchimp -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Steps how to get and use Mailchimp credentials
To get the credentials you need in order to set up your OAuth workflow, you'll first need to register your application with Mailchimp:-
Login into your Mailchimp account, click on your Profile Icon, and hit Account & billing:
-
Navigate to the Registered Apps page in your Mailchimp account:
-
Click Register An App button:
-
Fill-in the Register An App form and click Create button:
NOTE: For Redirect URI use Redirect URI (also called "Redirect URL" or "Callback URL") given by your IT administrator or just use
https://zappysys.com/oauth
, if you don't have one. -
After successfully registering your application,
you'll see the Client ID and Client Secret,
record these values and store them securely:
-
Record your Mailchimp data center, since we will need it later.
The data center is located in your browser's address bar URL.
If the URL is
https://us21.admin.mailchimp.com/account/api
, then your data center isus21
. - Now go to SSIS package or ODBC data source OAuth authentication configuration.
- Proceed by entering the data center into the Data Center field that was recorded in the previous step.
- Then enter the Client ID value into the Client ID field that you recorded in the previous step.
- Enter the Client Secret value into the Client Secret field that was recorded in the previous step.
- Click Generate Token. If proper authentication occurs, you will see a confirmation notice. If you get an error, click Yes on the dialog box and then a large browser window will launch. Then log into your Mailchimp account and approve the use of the application.
- Finally, hit the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
- If the connection test succeeds, select OK.
- Done! Now you can use Mailchimp Connector!
Fill in all required parameters and set optional parameters if needed:
MailchimpDSNMailchimpOAuth [OAuth]https://[$DataCenter$].api.mailchimp.comRequired Parameters Data Center Fill-in the parameter... Client Id Fill-in the parameter... Client Secret Fill-in the parameter... Default List Id Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True Steps how to get and use Mailchimp credentials
The simplest way to authenticate a request to the Mailchimp Marketing API is by using an API key (If you require access to Mailchimp on behalf of other Mailchimp users, you'll want to set up OAuth authentication instead)::-
Login into your Mailchimp account, click on your Profile Icon, and hit Account & billing:
-
Navigate to the API keys page in your Mailchimp account:
-
In the Your API keys section of the page, click Create A Key button:
-
Give your new key a descriptive name that will remind you which application it's used for:
-
Copy the API key immediately and store it in a secure location (you won't be able to see or copy the key once you finish generating it):
-
Record your Mailchimp data center, since we will need it later.
The data center is located in your browser's address bar URL.
If the URL is
https://us21.admin.mailchimp.com/account/api
, then your data center isus21
. - Now go to SSIS package or ODBC data source ApiKey Auth authentication configuration.
- Proceed by entering the data center into the Data Center field that was recorded in the previous step.
- Then enter the API key into the Api Key field that you copied earlier.
- Finally, click the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
- Done! Now you can use Mailchimp Connector!
Fill in all required parameters and set optional parameters if needed:
MailchimpDSNMailchimpApiKey Auth [Http]https://[$DataCenter$].api.mailchimp.comRequired Parameters Api Key Fill-in the parameter... Default List Id Fill-in the parameter... Optional Parameters Data Center RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True -
Login into your Mailchimp account, click on your Profile Icon, and hit Account & billing:
-
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - MailchimpRead / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.MailchimpDSN -
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in UiPath to retrieve data from Mailchimp. Hit OK button to use this query in the next step.
SELECT * FROM Campaigns
Some parameters configured in this window will be passed to the Mailchimp API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in UiPath:
ZappySys API Driver - MailchimpRead / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.MailchimpDSNSELECT * FROM Campaigns
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole result set will be retrieved from the Mailchimp API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Mailchimp servers). -
Click OK to finish creating the data source.
Video Tutorial
Read Mailchimp data in UiPath Studio (workstation)
Here we will be reading Mailchimp data on your workstation. To accomplish that we will create and run UiPath process package locally. Later on, we'll explore how to publish the package to Orchestrator and run it remotely. For now, let's focus on working locally and get started!
- Open UiPath Studio.
- Before we really begin the work, make sure UiPath Studio is set as your profile (blue application icon).
-
In case, it is set to UiPath StudioX, you can change it in UiPath StudioX Settings:
Simply select UiPath Studio option:
-
Start by creating a new project based on UiPath Process template:
-
Add Run Query activity in Main Sequence box:
-
Click Configure Connection... button to create an ODBC connection:
-
Continue by clicking Connection Wizard:
-
When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:
MailchimpDSNMailchimpDSNYou can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration.
-
Once you do that, it's time to configure a SQL query:
Make sure, you enclose the query in double quotes!
-
Proceed by adding a Write CSV activity after Run Query:
In this article we are using Write CSV, but you can freely add any other destination of your choice, e.g. Write DataTable to Excel.
-
Once you do that, configure the added Write CSV, this will write Mailchimp data to a CSV file:
-
It's time for fun! Which means it's time for debugging! Just run the package locally to debug:
-
Finally, ensure there are no execution errors!
Run UiPath package using Orchestrator (via robot)
UiPath also offers the ability to execute packages remotely using Orchestrator and a robot. This is achieved by publishing the package to UiPath Orchestrator, installing UiPath Assistant on the remote machine, connecting it to Orchestrator, enabling us to run the package remotely. It may sound complicated at first glance, but further steps will clear things out. Let's not waste our precious time and delve into the details!
Publish process package from UiPath Studio
- First of all, open the UiPath process package we created in the previous step
-
Set the option that our process package Starts in Background:
-
We are ready to Publish it:
-
Make sure, you publish it to the Shared folder in UiPath Orchestrator Tenant workspace:
-
Finally, success! We are ready for the next step - creating UiPath robot - so we can automate the job:
Create robot in UiPath Orchestrator
-
First of all, let's open UiPath Orchestrator from UiPath Automation Cloud console:
-
It's time to create a robot, which will run unattended packages:
-
But first we have to create a runtime. Choose to host our robot on-premise, not in UiPath infrastructure:
-
Let's move along and Create new machine template, this will create a machine in UiPath Orchestrator:
-
Configure the machine to run in Production environment:
-
We are ready to Create new robot account in the new machine:
-
Let's make our robot to work only on background automations:
-
Continue by selecting newly created robot:
-
Select Shared folder, so that everyone in the team can benefit from it:
This is the folder where we published our UiPath process package "MyProcess"
-
We are almost done!
We are given machine Client ID and Client secret which we will use to connect UiPath Assistant to our created machine in Orchestrator.
Let's leave this open for a while and see how we can do it in the next step.
Connect UiPath Assistant to Orchestrator
We are ready to connect UiPath Assistant to the machine we created in Orchestrator. UiPath Assistant will run our package in a remote machine. Let's connect it and give it some work!
- Connect to a remote machine (where your UiPath process package will be running).
- Install UiPath Studio there.
- Then configure ODBC data source:
If you chose Use user or system data source option in connection configuration, when creating UiPath process package, then create an identical ODBC data source on the same remote machine. Use the same configuration as the one created in your workstation in the first step.
Use Copy Settings and Load Settings buttons to make your life easier. They will help you to transfer settings between different ODBC data sources.If you chose Use connection string option, then you don't have to do anything. However, you still have to install ODBC PowerPack on the remote machine.
-
Continue by opening UiPath Assistant and going to Preferences:
-
Find Orchestrator Settings menu item and click it:
-
And here even bigger fun begins! But fear not, all you have to do is open your web browser window with Client ID & Client secret we obtained in the previous step and simply copy and paste those values into UiPath Assistant. Also, don't forget to configure Orchestrator URL:
-
Finally, we get rewarded for the hard work with the Connected as Unattended status:
Create and run UiPath process in Orchestrator
We are at the finish line! Let's create and run UiPath process. This will execute the package on your remote machine using the UiPath Assistant configured earlier.
- First of all, open UiPath Orchestrator from UiPath Automation Cloud console.
-
Then proceed by going to Process in Shared folder:
-
Continue by simply clicking on Add process button:
-
Select the process package we created in UiPath Studio:
-
Rest a while, and just hit Next, unless your package has requirements:
-
Then simply hit Create button:
-
But let's not stop here and Start the process by creating a job right away:
-
Use the same Production runtime we created before and hit Start:
-
We've reached the final step! In the CSV destination file or destination of your choice you should see Mailchimp data:
Actions supported by Mailchimp Connector
Learn how to perform common Mailchimp actions directly in UiPath with these how-to guides:
- Add New List
- Add New List Member
- Add New List Members in Bulk
- Add or Update Upsert List Members (Bulk Subscribe or Unsubscribe)
- Delete List
- Delete List Member (Archive)
- Delete List Member (Permanent delete)
- Get a Specific Member From All Lists
- Get All Members in All Lists
- Get Campaign Details
- Get List Details
- Get List Member Details
- Get List Members
- Get List of Campaigns
- Get Lists
- Get User Details
- Update List Details
- Update List Member Details
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Mailchimp in UiPath and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Mailchimp, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Mailchimp Connector for UiPath and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Mailchimp Connector for UiPath Documentation
More integrations
Other connectors for UiPath
Other application integration scenarios for Mailchimp
How to connect Mailchimp in UiPath?
How to get Mailchimp data in UiPath?
How to read Mailchimp data in UiPath?
How to load Mailchimp data in UiPath?
How to import Mailchimp data in UiPath?
How to pull Mailchimp data in UiPath?
How to push data to Mailchimp in UiPath?
How to write data to Mailchimp in UiPath?
How to POST data to Mailchimp in UiPath?
Call Mailchimp API in UiPath
Consume Mailchimp API in UiPath
Mailchimp UiPath Automate
Mailchimp UiPath Integration
Integration Mailchimp in UiPath
Consume real-time Mailchimp data in UiPath
Consume real-time Mailchimp API data in UiPath
Mailchimp ODBC Driver | ODBC Driver for Mailchimp | ODBC Mailchimp Driver | SSIS Mailchimp Source | SSIS Mailchimp Destination
Connect Mailchimp in UiPath
Load Mailchimp in UiPath
Load Mailchimp data in UiPath
Read Mailchimp data in UiPath
Mailchimp API Call in UiPath