← Documentation

Mailchimp

Mailchimp is a marketing platform that helps businesses create and manage email campaigns, store customer information, and access advanced features. With Forms Bridge you can get your contact forms and subscription forms bridged to its mailing lists.

Mailchimp campaigns dashboard UI

The addon

Mailchimp’s Marketing API as a REST-like HTTP API. Using the this API you can manage your account, automations, campaigns, lists, and more. To talk with this API the addon uses a modified version of the generic REST API bridge of Forms Bridge. In addition, the addon comes with a a template and a couple of workflow jobs to bridge your WordPress forms to your mailing lists.

Backend

To configure the Marketing API as a backend, you will need to generate an API key going to your Account settings on your Mailchimp dashboard. Under the Extras > API keys tab, click on Create A Key and create a new key. The key requires an name, for example “Forms Bridge”.

The key value should looks like a long random string like 95UkqT5NG74w8dz9171J7xe7WL3002mb8-us1. Copy the key and go to the General settings page and open the backends panel. Add a new backend with “Mailchimp API” as name and https://us1.api.mailchimp.com as the URL value.

Once registered, on the headers table add a header with api-key as name and the key as its value. Now you have your backend ready to use.

The first part of the backend URL (us1) is the data center prefix and it should match the data center for your account. There are a few ways to find your data center. It’s the first part of the URL you see in the API keys section of your account; if the URL is https://us6.mailchimp.com/account/api/, then the data center subdomain is us6. It’s also appended to your API key in the form key-dc; if your API key is 0123456789abcdef0123456789abcde-us6, then the data center subdomain is us6

You can achieve the same result using the template wizard with one of the addon’s template.

Bridges

The addon’s bridge is an extension of the REST API. Because of this they looks so similar. Like the REST API bridge, the addon’s bridge requires, in addition to the common fields (name, backend, form) an endpoint and an HTTP method.

The bridge endpoint has to exists on the API. To get a comprehensive list of the available endpoints you can check the official documentation. For example, to get your contact form bridged to your mailing lists you have to set the bridge endpoint to /3.0/lists/<list_id>/members.

The bridge allows you to use 4 HTTP methods (GET, POST, PUT, DELETE). In most cases you only want to use the POST method as it is the standard method to write entries on a system through a REST API.

Templates

The addon comes packed with the following templates:

  • Subscription 🔎
    Subscription form template. The resulting bridge will convert form submissions into new list subscriptions.

  • Subscription 🔎
    Subscription form template. The resulting bridge will subscribe woocommerce customers to a given mailchimp audience.

Workflow jobs

The addon comes packed with the following workflow jobs: