Mailchimp

Manage a user's Mailchimp audiences, contacts and campaigns.

Marketing
OAuth 2.0
Works on Free plan
Bundled in Kirak
Maintained by Kirak

How to use it

This profile ships with Kirak. Add "integrations" to modules in kirak.json, then name the profile as below. There is nothing to download, and a copy in your project's integrations/ folder is an error.

Environment variables

Variable	Holds
`KIRAK_INTEGRATION_MAILCHIMP_CLIENT_SECRET`	The OAuth client secret from the vendor's console. Secret: keep it out of kirak.json and out of source control.
`KIRAK_AUTH_ENCRYPTION_KEYS`	Encrypts stored tokens. Shared by every integration; the module refuses to start without it.

The names follow the integration's name in kirak.json (mailchimp here). Name it something else, such as mailchimp_sales, and the variables change to match.

Redirect URL

Register this as the redirect (callback) URL in the vendor's console, with your app's address in place of <your-app> (the base_url in kirak.json):

https://<your-app>/integrations/mailchimp/callback

How to get your keys

Sign in to Mailchimp and open your profile’s Extras > Registered apps.
Choose Register an app and fill in the app details.
Set the redirect URI to https://<your-app>/integrations/mailchimp/callback.
Copy the client ID and the client secret.
Put the client ID in kirak.json as integrations.providers.mailchimp.client_id, and the client secret in the environment as KIRAK_INTEGRATION_MAILCHIMP_CLIENT_SECRET. Never put the secret in kirak.json.

The vendor's own guide · Instructions out of date? ·Suggest an edit

kirak.json

{
  "integrations": {
    "providers": {
      "mailchimp": {
        "type": "oauth2",
        "profile": "mailchimp",
        "client_id": "your-client-id"
      }
    }
  }
}

Merged into the profile: scope replaces the profile's default scopes.

Good to know

The data centre host is read from the metadata endpoint after the token. The field name (api_endpoint) is not confirmed: the vendor sources disagree (dc or api_endpoint). Check a live response before release.
Marketing API tokens do not expire; there is no refresh.
Not verified against the vendor docs in this session: check the facts before release.

Help improve this profile

Report a problem ·Suggest an edit to profile.json ·Add a profile ·Vendor docs the profile was checked against

Product names and logos are trademarks of their respective owners. Their use does not imply endorsement. To ask for this icon to be removed, email trademark@kirak.io.