​
Mailchimp Provider

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

​
Inputs

The notify function of MailchimpProvider takes the following arguments:

  • _from (str): Required. The email address of the sender.
  • to (str): Required. The email address of the recipient.
  • subject (str): Required. The subject of the email.
  • html (str): Required. The HTML body of the email.
  • **kwargs (optional): Additional optional parameters can be provided as key-value pairs.

See documentation for more

​
Outputs

The notify function of MailchimpProvider outputs the following format (example):

{
  "email": "[email protected]",
  "status": "sent",
  "_id": "8db77476a09d4b47ae1b9bc69d1c74e3",
  "reject_reason": null,
  "queued_reason": null
}

See documentation for more

​
Authentication Parameters

The Mailchimp provider requires the following authentication parameter:

  • api_key: Required. Mailchimp Transactional API key. You can obtain an API key by visiting Mailchimp API Keys.

​
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: "[email protected]"
          to: "[email protected]"
          subject: "Hello from Mailchimp Provider"
          html: "<p>This is the email body.</p>"