​
Mailchimp Provider

MailchimpProvider is a class that implements the Mailchimp API and allows email sending through Keep.

​
Authentication

This provider requires authentication.

  • api_key: Mailchimp API key (required: True, sensitive: True)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

  • connect_to_client: The user can connect to the client (mandatory)

​
In workflows

This provider can be used in workflows.

As “action” to make changes or update data, example:

actions:
    - name: Query mailchimp
      provider: mailchimp
      config: "{{ provider.my_provider_name }}"
      with:
        _from: {value}  # From email address
        to: {value}  # To email address
        subject: {value}  # Email subject
        html: {value}  # Email body

If you need workflow examples with this provider, please raise a GitHub issue.

{
  "email": "user@example.com",
  "status": "sent",
  "_id": "8db77476a09d4b47ae1b9bc69d1c74e3",
  "reject_reason": null,
  "queued_reason": null
}

See documentation for more

​
Connecting with the Provider

To connect with the Mailchimp provider and send emails through Keep, follow these steps:

  1. Obtain a Mailchimp Transactional API key: Visit Mailchimp API Keys to obtain an API key if you don’t have one already.
  2. Configure the Mailchimp provider in your system with the obtained API key.
  3. Use the following YAML example to send an email notification using the Mailchimp provider:
title=examples/alert_example.yml
# Send an email notification using the Mailchimp provider.
alert:
  id: email-notification
  description: Send an email notification using Mailchimp
  actions:
    - name: send-email
      provider:
        type: mailchimp
        config: "{{ providers.mailchimp-provider }}"
        with:
          _from: "sender@example.com"
          to: "recipient@example.com"
          subject: "Hello from Mailchimp Provider"
          html: "<p>This is the email body.</p>"