Mailchimp Query Authentication Guide

Mailchimp Query Authentication Guide


Overview

This is a step-by-step guide to creating an OAuth entry, acquiring credentials and authorising the Mailchimp Query connector for use in Matillion ETL.

Important Information

  • The Mailchimp Query connector uses either an OAuth or an API token for third-party authentication.
  • While connector properties may differ between Cloud Data Warehouses, the authentication process remains the same.

Creating an OAuth Entry in Matillion ETL

  1. In Matillion ETL, on the top left of the screen, click ProjectManage OAuth.

    Please Note

    • If an API token is being used to authenticate the Mailchimp Query connector, skip to Acquiring Third-Party Credentials.
    • If a Mailchimp Query connector has already been added to an Orchestration Job, the Manage OAuth window may also be accessed using the following method:
      1. Click the connector icon to open the Properties panel at the bottom of the screen.
      2. Then, click ... next to the Authentication Method input.
      3. Select OAuth from the dropdown menu in the pop-up window and click OK.
      4. The Authentication input will now appear on the list of properties. Click ... next to it, and finally click Manage in the pop-up window.
    Project dropdown menu

    Project dropdown menu

  2. Copy the Callback URL in the field at the top of the window as this will be required in Acquiring Third-Party Credentials.

  3. Click + in the bottom left of the window to open the Create OAuth Entry window.

    New OAuth entry

    New OAuth entry

  4. Click the Service dropdown menu and select Mailchimp. Then, provide a name for the OAuth in the Name field and click OK.

    Create OAuth Entry window

    Create OAuth Entry window

  5. On returning to the Manage OAuth window, check the list of OAuths to ensure the new entry is listed.

    Please Note

    This entry is Not Configured. Configuration of the OAuth entry will be discussed in Authorising for use in Matillion ETL.

    New Entry listed on Manage OAuth window

    New Entry listed on Manage OAuth window


Acquiring Third-Party Credentials

  1. Navigate to the Mailchimp website and click Log In, found both on the top right of the screen or on the main body of the page. The browser will then redirect to a login screen. Enter valid login credentials to continue.

    Mailchimp homepage

    Mailchimp homepage

  2. Once logged in, the browser will open the Campaigns dashboard. Then at the top right of the screen, click the <Profile Name>Account.

    Select Profile and Account on Campaigns Dashboard

    Select Profile and Account on Campaigns Dashboard

  3. On the next screen, click ExtrasAPI keys.

    Please Note

    If an API token is being used to authenticate the Mailchimp Query connector, skip to step 8.

    Selects Extras and then API keys

    Selects Extras and then API keys

  4. On the API keys page, click Register And Manage Your Apps found in the Developing an app? section.

    API keys on App Dashboard

    API keys on App Dashboard

  5. On the Registered apps page, click Register An App found at the bottom of the apps list.

    Register An App on Registered App screen

    Register An App on Registered App screen

  6. On the Register An App page, provide details for the following fields:

    • App name – provide a name for the app
    • App description – provide an description for the app
    • Company / organization – provide the name of the company or organization that will be associated with the app
    • App website – provide a URL for the app website
    • Redirect URI – paste the Callback URL (copied from the Manage OAuth window in Matillion ETL earlier), and click Create

    Please Note

    Uploading a logo for the app is not mandatory.

    Entering app details

    Entering app details

  7. If the details for the app are accepted, the screen will refresh, and a Client ID and Client secret will be generated and appear at the bottom of the window. Copy the codes in each field as they will be required in Authorising for use in Matillion ETL.

    Please Note

    • Make sure to copy the Client Secret right away as it may appear only once.
    • Additionally, when copying the codes, some browsers may add a space to the end of the code. Watch out for this as it will cause the credentials to fail.
    Client ID and Client secret

    Client ID and Client secret

  8. Return to the API keys screen by clicking ProfileAccount then ExtrasAPI keys. Then, click Create A Key, found at the bottom of the Your API keys list.

  9. A new API key will be generated and appear at the top of the Your API keys list. Copy this key as it will be required in Authorising for Use in Matillion ETL.

    Create API key

    Create API key


Authorising for Use in Matillion ETL with an OAuth

  1. Return to the Manage OAuth window in Matillion ETL and click next to the previously created OAuth entry. This will open the Configure OAuth window.

    Please Note

    If an API token is being used to authenticate the Mailchimp Query connector, skip to Authorising for Use in Matillion ETL with an API Key.

    Configure OAuth settings

    Configure OAuth settings

  2. Using the codes copied from the Mailchimp website earlier, provide details for the following fields:

    Configure OAuth settings

    Configure OAuth settings

  3. The next window will have an Authorization link. Click the link to authorise Matillion ETL to use the acquired credentials.

    Authorization link

    Authorization link

  4. The browser will then redirect to a login screen to connect the Mailchimp account to the app. In the respective fields, enter the username and password (used to log in to the Mailchimp website earlier). Then, click Log In to confirm the connection.

    Connect your Mailchimp account

    Connect your Mailchimp account

  5. If all is successful, the browser will return to Matillion ETL with a window stating, "Authorization Successful".

    OAuth Authorization successful

    OAuth Authorization successful



Authorising for Use in Matillion ETL with an API Key

  1. If a Mailchimp Query connector has not already been dragged onto the job canvas, search "Mailchimp" using the Components panel search field, or find the Mailchimp Query connector under OrchestrationLoad/UnloadCRM & Marketing Automation.

    Please Note

    An Orchestration Job must be open on the job canvas within Matillion ETL to ensure the Mailchimp Query connector is searchable within the Components panel.

  2. Then, click and drag the Mailchimp Query connector onto the job canvas.

    Search for Mailchimp Query connector

    Search for Mailchimp Query connector

  3. Click the connector icon on the job canvas to open the Properties panel at the bottom of the screen.

  4. Then, click ... next to the API Key input.

    Open Mailchimp Query connector properties

    Open Mailchimp Query connector properties

  5. In the API key pop-up window, paste the API key (copied from the Mailchimp website earlier) into the Store in connector field and click OK.

    Please Note

    Passwords and codes can also be saved using the Matillion ETL Password Manager. To learn how to do this, please refer to the Manager Passwords article.

    Paste API Key

    Paste API Key

  6. If the API Key is entered correctly, the connector should be authenticated and the status of the input will be displayed as OK.

    Connector successfully authenticated

    Connector successfully authenticated