SendGrid Query Authentication Guide

SendGrid Query Authentication Guide


Overview

This is a step-by-step guide to acquiring credentials and authorising the SendGrid Query connector for use in Matillion ETL.

Important Information

  • The SendGrid Query connector uses either a username and password or an API token for third-party authentication. This guide will only explain the API token method.
  • While connector properties may differ between Cloud Data Warehouses, the authentication process remains the same.

Creating an OAuth Entry in Matillion ETL

  1. Navigate to the SendGrid app portal. The SendGrid login screen will appear immediately. Enter valid login credentials to continue. The browser will then redirect to the SendGrid app dashboard. Then, on the sidebar, click settingsAPI Keys to open the API Keys window.

  2. Then, in the top right of the API Keys window, click Create API Key.

    API Keys

    API Keys

  3. The Create API Key panel will open. Provide details for the following fields:

    • API Key Name – provide a descriptive name for the API key
    • API Key Permissions – select the level of access the API key will allow, then click Create & View

    Create API Key

    Create API Key

  4. The next screen will display the newly created API key.

    Please Note

    • Make sure to copy the API token right away as it will only appear once.
    • When copying the token, some browsers may add a space to the end of the string. Watch out for this as it will cause the credentials to fail.
    Copy API Key

    Copy API Key


Authorising for use with Matillion ETL

  1. If a SendGrid Query connector is not already on the job canvas, search "SendGrid" using the Components search field, or find the SendGrid 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 SendGrid Query connector is searchable within the Components panel.

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

    Search for SendGrid Query connector

    Search for SendGrid 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 Authentication Method.

    Open SendGrid Query connector properties

    Open SendGrid Query connector properties

  5. In the the Authentication Method pop-up window, select API Key from the dropdown and click OK. The API Key input will now appear in the list of properties under the Authentication Method input.

    Select Authentication Method

    Select Authentication Method

  6. Finally, click ... next to the API Key input. Then, in the API Key pop-up window, paste the API key (copied from the SendGrid app portal earlier) into the Store in component 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 the API Key

    Paste the API token

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

    Authorizing Successful

    Authorising Successful