Mailchimp: Destination Connector

[Mohith93]

Feature Request: Mailchimp Destination Connector

Issue Type: New Feature / Connector Request

Description

We need to build a Mailchimp Destination Connector that allows users to send data from Multiwoven to their Mailchimp account. This connector will help users automate email marketing campaigns, manage audiences, and sync customer data between Multiwoven and Mailchimp.

Requirements

• Authentication:
  The connector should support API Key authentication to interact securely with Mailchimp’s API. The user will need to generate an API key from their Mailchimp account.

• Configuration:
  The connector should require the following configuration parameters:

  • api_key: Mailchimp API key.
  • list_id: The ID of the Mailchimp audience list where data will be synced.
  • Optional: email_template_id for users who want to send pre-designed email templates.

• Connector Features:
  The destination connector should be able to:

  1. Sync the following data to Mailchimp:
     • Audience lists (e.g., customer and subscriber information).
     • Tags and segmentation information.
     • Email campaigns (both bulk and individual emails).
  2. Allow users to map their data fields in Multiwoven to Mailchimp fields, such as:
     • First name, last name, email, and other customer attributes.
  3. Support adding and updating subscribers in Mailchimp, ensuring that users can manage audience data effectively.

• API Interaction:
  The connector should use the Mailchimp Marketing API for data sync and campaign management. API documentation can be found here:
  Mailchimp API Documentation

• Data Format:
  Data must follow the required structure for Mailchimp’s audience and campaign APIs, such as JSON objects that represent contacts, tags, and other relevant fields.

• Error Handling:
  The connector should handle errors gracefully, including:

  • Invalid API keys.
  • List ID mismatches.
  • Rate limits and API call failures.

Steps to Implement

1. Authentication Setup:

   • Implement API Key authentication to interact with Mailchimp’s Marketing API.

2. Connector Configuration:

   • Create a configuration file that accepts the required parameters (api_key, list_id, email_template_id).

3. API Integration:

   • Implement the logic to sync data from Multiwoven to Mailchimp’s API:
     • Syncing subscriber data to an audience list.
     • Syncing tags and segmentation information.
     • Creating and sending email campaigns via Mailchimp’s Campaign API.

4. Field Mapping:

   • Enable users to map their data fields in Multiwoven to Mailchimp’s fields (e.g., customer name, email, tags).
   • Handle mapping for both custom fields and predefined fields in Mailchimp.

5. Error Handling & Logging:

   • Implement error handling for common issues like invalid API credentials or mismatched list IDs.
   • Provide detailed logs for successful and failed sync operations.

6. Testing:

   • Write unit tests and integration tests to verify the connector’s functionality.
   • Use mock API calls to test data syncing and campaign creation.

7. Documentation:

   • Provide a detailed README.md explaining how to configure and use the connector.
   • Include examples of data syncing, audience management, and email campaign creation.

Acceptance Criteria

• The connector successfully syncs data with Mailchimp, including audience lists, tags, and campaigns.
• Proper error handling is implemented, and detailed logs are available for debugging.
• Unit and integration tests provide coverage for key scenarios, including subscriber sync, audience updates, and campaign creation.
• Comprehensive documentation is provided to help users configure and use the connector.

Resources

• Mailchimp API Documentation
• Mailchimp Authentication Guide
• Mailchimp Rate Limits

[linear[bot]]

BE-466 Mailchimp: Destination Connector