Creating an OAuth for your custom or Flex connector

Some of your custom connectors will require you to authenticate using OAuth 2.0 client credentials and an API access token. In such scenarios, you can create a client credentials OAuth connection and reference this provider when using your custom connector in your data pipelines in Designer.

This topic is for OAuth 2.0 client credentials, not authorization code OAuth connections.

Note

Currently, you need to pass your client ID and client secret twice during this flow. Once when creating your OAuth in Custom Connector, and again when creating your OAuth in your Designer project. We are working hard to improve this user experience.

---

Prerequisites

• You'll need a custom connector.
• You'll need your client credentials (normally a client ID and a client secret). These are usually generated when creating an application in the developer portal of the service you're connecting to (Facebook, Salesforce, Shopify, and so on).
• You'll need the access token URL, which is used to send an API access token POST request. You can usually find this URL in the API documentation of the service you're connecting to.

---

Create an OAuth in Custom Connector

To create a client credentials OAuth connection, follow these steps:

1. Log in to the Matillion Hub.
2. Click ☰ → Manage → Custom Connectors.
3. Click OAuths.
4. Click Add OAuth and complete the following fields:
   • Name: Give your OAuth connection a unique name so you can find and reuse it later.
   • Grant Type: Set this as Client Credentials.
   • Client ID: Add your client ID.
   • Client Secret: Add your client secret.
   • Access Token URL: The URL to send an API access token POST request to. You can usually find this URL in the API documentation of the service you're connecting to.
   • Token Parameters: Specify any additional query, header, or body parameters in your API access token request. Click + Add parameters to add a new row in the corresponding tab. The documentation for the service you're connecting to should specify any additional access token request parameters to include.
5. Click Authorize. On success, you will be returned to the OAuths page.

---

Set up your OAuth connection in Designer

In this section, you'll add your custom connector to the Designer pipeline canvas and create an OAuth connection in your project.

1. Click ☰ → Designer.
2. Choose your project and your branch.
3. Open an existing orchestration pipeline or create a new one.
4. Add your custom connector to the pipeline canvas.
5. Select the data source you want to load.
6. In the Authentication Type property, choose OAuth 2.0 Client Credentials.
7. In the next property, Authentication, click Manage. A new browser tab will open at the OAuth tab of your project.

8. Click Add OAuth connection and complete the following fields:

   • OAuth name: Give your OAuth connection a unique name so you can find and reuse it later.

   • Provider: Select the service you're connecting to.

     Note

     This service you're connecting to won't be available in this drop-down menu until you've created the OAuth connection in Custom Connector.

   • Authentication type: Click OAuth 2.0 client credentials.

   • Client ID: Add your client ID.
   • Client Secret: Add your client secret.

9. Click Authorize. On success, you will be returned to the OAuths tab of your project. Close this tab.

10. In Designer, close and reopen the Authentication property and select your new OAuth connection from the drop-down menu.
11. Configure the rest of your custom connector.