Mailchimp
This page guides you through setting up the Mailchimp source connector.
Prerequisites
For Airbyte Cloud
- Access to a valid Mailchimp account. If you are not an Owner/Admin of the account, you must be granted Admin access by the account's Owner/Admin.
For Airbyte Open Source
- A valid Mailchimp API Key (recommended) or OAuth credentials: Client ID, Client Secret and Access Token
Setup guide
Airbyte Open Source: Generate a Mailchimp API key
- Navigate to the API Keys section of your Mailchimp account.
- Click Create New Key, and give the key a name to help you identify it. You won't be able to see or copy the key once you finish generating it, so be sure to copy the key and store it in a secure location.
For more information on Mailchimp API Keys, please refer to the official Mailchimp docs. If you want to use OAuth authentication with Airbyte Open Source, please follow the steps laid out here to obtain your OAuth Client ID, Client Secret and Access Token.
Set up the Mailchimp source connector
- Log into your Airbyte Cloud or Airbyte Open Source account.
- Click Sources and then click + New source.
- Find and select Mailchimp from the list of available sources.
- Enter a name for your source.
- You can use OAuth or an API key to authenticate your Mailchimp account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte Open Source.
- To authenticate using OAuth for Airbyte Cloud, click Authenticate your Mailchimp account and follow the instructions to sign in with Mailchimp and authorize your account.
- To authenticate using an API key for Airbyte Open Source, select API key from the Authentication dropdown and enter the API key for your Mailchimp account.
- To authenticate using OAuth credentials, select Oauth2.0 from the dropdown and enter the Client ID, Client Secret and Access Token you obtained.
- (Optional) You may optionally provide an Incremental Sync Start Date using the provided datepicker, or by programmatically entering a UTC date-time in the format
YYYY-MM-DDThh:mm:ss.sssZ. If set, only data generated on or after the configured date-time will be synced. Leaving this field blank will sync all data returned from the API. - Click Set up source and wait for the tests to complete.
Supported streams
The Mailchimp source connector supports the following streams and sync modes:
| Stream | Full Refresh | Incremental |
|---|---|---|
| Automations | ✓ | ✓ |
| Campaigns | ✓ | ✓ |
| Email Activity | ✓ | ✓ |
| Interests | ✓ | |
| Interest Categories | ✓ | |
| Lists | ✓ | ✓ |
| List Members | ✓ | ✓ |
| Reports | ✓ | ✓ |
| Segments | ✓ | ✓ |
| Segment Members | ✓ | ✓ |
| Tags | ✓ | |
| Unsubscribes | ✓ | ✓ |
A note on primary keys
The EmailActivity and Unsubscribes streams do not have an id primary key, and therefore use the following composite keys as unique identifiers:
- EmailActivity [
email_id,action,timestamp] - Unsubscribes [
campaign_id,email_id,timestamp]
All other streams contain an id primary key.
Data type mapping
| Integration Type | Airbyte Type | Notes |
|---|---|---|
array | array | the type of elements in the array is determined based on the mappings in this table |
string | string | |
float, number | number | |
integer | integer | |
object | object | properties within objects are mapped based on the mappings in this table |
string (timestamp) | timestamp_with_timezone | Mailchimp timestamps are formatted as YYYY-MM-DDTHH:MM:SS+00:00 |
Limitations & Troubleshooting
Expand to see details about Mailchimp connector limitations and troubleshooting
Connector limitations
Mailchimp does not impose rate limits on how much data is read from its API in a single sync process. However, Mailchimp enforces a maximum of 10 simultaneous connections to its API, which means that Airbyte is unable to run more than 10 concurrent syncs from Mailchimp using API keys generated from the same account.
Tutorials
Now that you have set up the Mailchimp source connector, check out the following Mailchimp tutorial:
Reference
Config fields reference
Field
Type
Property name
object
credentials
string
start_date
string
data_center
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 2.0.6 | 2024-06-21 | 39937 | Update dependencies |
| 2.0.5 | 2024-06-18 | 38868 | Refactor: use client_side_incremental feature |
| 2.0.4 | 2024-06-06 | 39202 | [autopull] Upgrade base image to v1.2.2 |
| 2.0.3 | 2024-05-02 | 36649 | Schema descriptions |
| 2.0.2 | 2024-04-25 | 37572 | Fixed start_date format issue for the email_activity stream |
| 2.0.1 | 2024-04-19 | 37434 | Fixed cursor format for the email_activity stream |
| 2.0.0 | 2024-04-01 | 35281 | Migrate to Low-Code |
| 1.2.0 | 2024-03-28 | 36600 | Migrate to latest Airbyte-CDK. |
| 1.1.2 | 2024-02-09 | 35092 | Manage dependencies with Poetry. |
| 1.1.1 | 2024-01-11 | 34157 | Prepare for airbyte-lib |
| 1.1.0 | 2023-12-20 | 32852 | Add optional start_date for incremental streams |
| 1.0.0 | 2023-12-19 | 32836 | Add airbyte-type to datetime columns and remove ._links column |
| 0.10.0 | 2023-11-23 | 32782 | Add SegmentMembers stream |
| 0.9.0 | 2023-11-17 | 32218 | Add Interests, InterestCategories, Tags streams |
| 0.8.3 | 2023-11-15 | 32543 | Handle empty datetime fields in Reports stream |
| 0.8.2 | 2023-11-13 | 32466 | Improve error handling during connection check |
| 0.8.1 | 2023-11-06 | 32226 | Unmute expected records test after data anonymisation |
| 0.8.0 | 2023-11-01 | 32032 | Add ListMembers stream |
| 0.7.0 | 2023-10-27 | 31940 | Implement availability strategy |
| 0.6.0 | 2023-10-27 | 31922 | Add Segments stream |
| 0.5.0 | 2023-10-20 | 31675 | Add Unsubscribes stream |
| 0.4.1 | 2023-05-02 | 25717 | Handle unknown error in EmailActivity |
| 0.4.0 | 2023-04-11 | 23290 | Add Automations stream |
| 0.3.5 | 2023-02-28 | 23464 | Add Reports stream |
| 0.3.4 | 2023-02-06 | 22405 | Revert extra logging |
| 0.3.3 | 2023-02-01 | 22228 | Add extra logging |
| 0.3.2 | 2023-01-27 | 22014 | Set AvailabilityStrategy for streams explicitly to None |
| 0.3.1 | 2022-12-20 | 20720 | Use stream slices as a source for request params instead of a stream state |
| 0.3.0 | 2022-11-07 | 19023 | Set primary key for Email Activity stream. |
| 0.2.15 | 2022-09-28 | 17326 | Migrate to per-stream states. |
| 0.2.14 | 2022-04-12 | 11352 | Update documentation |
| 0.2.13 | 2022-04-11 | 11632 | Add unit tests |
| 0.2.12 | 2022-03-17 | 10975 | Fix campaign's stream normalization |
| 0.2.11 | 2021-12-24 | 7159 | Add oauth2.0 support |
| 0.2.10 | 2021-12-21 | 9000 | Update connector fields title/description |
| 0.2.9 | 2021-12-13 | 7975 | Updated JSON schemas |
| 0.2.8 | 2021-08-17 | 5481 | Remove date-time type from some fields |
| 0.2.7 | 2021-08-03 | 5137 | Source Mailchimp: fix primary key for email activities |
| 0.2.6 | 2021-07-28 | 5024 | Source Mailchimp: handle records with no no "activity" field in response |
| 0.2.5 | 2021-07-08 | 4621 | Mailchimp fix url-base |
| 0.2.4 | 2021-06-09 | 4285 | Use datacenter URL parameter from apikey |
| 0.2.3 | 2021-06-08 | 3973 | Add AIRBYTE_ENTRYPOINT for Kubernetes support |
| 0.2.2 | 2021-06-08 | 3415 | Get Members activities |
| 0.2.1 | 2021-04-03 | 2726 | Fix base connector versioning |
| 0.2.0 | 2021-03-09 | 2238 | Protocol allows future/unknown properties |
| 0.1.4 | 2020-11-30 | 1046 | Add connectors using an index YAML file |