# Add a Connector

To add a new connector, follow these steps:

**Step 1**: In the left navigation panel, click **Connectors**.

<figure><img src="/files/C9OA3hgni1oi8zCacQ5l" alt=""><figcaption></figcaption></figure>

**Step 2**: Click **Add New Connector** located at the top-right corner of the screen.

<figure><img src="/files/lD4tybm8WqwswZDyTnWB" alt=""><figcaption></figcaption></figure>

**Step 3**: In the **Name** field, enter the name of the connector.

**Step 4**: In the **Description** field, enter a brief description of the connector.

<figure><img src="/files/OImJKCP1FsrbEFk1a9Em" alt=""><figcaption></figcaption></figure>

**Note**: The **Name** and **Description** fields are mandatory. If these fields are not filled in and you click the **Save** button, an error message will appear stating **Connector name/ Connector description cannot be empty**.

**Step 5**: Click the **Save** button located on the upper-right side of the screen.

<figure><img src="/files/84vRDgwcT2qd06LgmDEU" alt=""><figcaption></figcaption></figure>

**Note**: Click the **Cancel** button to discard changes.

**Step 6**: A confirmation popup will appear, stating **Connector was created successful**, indicating that the connector has been successfully created.

![Connector Added](https://stg.ingestlabs.com/docs/images/customerdataplatformimages/connectorscreensuccessfully.png)

**Note**: Once saved, the **Info**, **Properties**, and **Metadata** tabs will appear, where you can add more details for the connector.

**Step 7**: By default, the **Properties** tab opens. Click **Edit** and click **Select** **Connector Types**.

<figure><img src="/files/EZFS5Cf7AVy9eHWgrLH6" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/yaEiu49u2FjPitKMLxHm" alt=""><figcaption></figcaption></figure>

**Step 8:** The **Select Connector Type** list opens on the right. Select the appropriate connector type.

<figure><img src="/files/agXBTAwjtzLroXIl0maK" alt=""><figcaption></figcaption></figure>

### Overview of Connector types <a href="#overviewofconnectortypes" id="overviewofconnectortypes"></a>

## AWS <a href="#aws" id="aws"></a>

![Save Destination](https://stg.ingestlabs.com/docs/images/customerdataplatformimages/awsimageone.png) **AWS IAM Role**

To connect the **AWS IAM Role**, click **AWS IAM Role**. Under **Properties**, you will see the **Access IAM ARN** field. Enter the required value in this field.

<figure><img src="/files/cX7FdEBdN7iav9e8Sw0E" alt=""><figcaption></figcaption></figure>

**Note**: Fields marked with an asterisk (\*) are mandatory.

Click **Save** to save the changes.

<figure><img src="/files/4mP5v2ndUGcW5VxlPlG3" alt=""><figcaption></figcaption></figure>

### POSTGRES <a href="#postgres" id="postgres"></a>

![Save Connector](https://stg.ingestlabs.com/docs/images/customerdataplatformimages/connecterpro.png) **Postgres credentials**

To connect **Postgres credentials**, click **Postgres credentials**. The following fields will be displayed:

* **Host**: Enter the Postgres server IP address.
* **Port**: Enter the port number where Postgres is running.
* **Database**: Enter the name of the database to connect to.
* **Username**: Enter the Postgres username.
* **Password**: Enter the Postgres password associated with the username.

<figure><img src="/files/UIFltOSIsuOiQwqvl17p" alt=""><figcaption></figcaption></figure>

**SSL**: Specify if SSL is required for the connection.

* True - Enables SSL for a secure, encrypted connection.
* False - Disables SSL, allowing an unencrypted connection.

**SSL Mode**: Choose the appropriate SSL mode.

* DISABLE - No SSL encryption.
* VERIFY-CA - Requires SSL and verifies the server’s certificate authority (CA).
* ALLOW - Uses SSL if supported but doesn’t require it.
* REQUIRE - Enforces SSL encryption without verification.
* PREFER - Prefers SSL but allows non-SSL connections if SSL is unavailable.
* VERIFY-FULL: Enforces SSL encryption and verifies the server’s SSL certificate against trusted Certificate

<figure><img src="/files/6kUiqH7icTgep9CgraD6" alt=""><figcaption></figcaption></figure>

Click **Save** to save the changes.

### API <a href="#api" id="api"></a>

![Save Connector](https://stg.ingestlabs.com/docs/images/customerdataplatformimages/connnectorapi.png) **API Keys**

To connect the API Keys, click **API Keys**. Under **Properties**, in the **Auth Type** field, click the **Select** dropdown. You will see the following options. Select the appropriate authentication type.

* JWT - Uses a signed token for secure authentication without needing to send credentials with every request.
* API\_KEY - Requires a unique key for authentication, typically passed in the request header.
* OAUTH2 - A secure authorization framework that grants limited access using tokens instead of credentials.
* POP\_TOKEN - Enhances security by requiring proof that the client owns the token, reducing the risk of misuse.

<figure><img src="/files/0kqoPY5oNgvO03ZGNUtP" alt=""><figcaption></figcaption></figure>

In the **Headers** field, the following fields are available:

* **Name**: Enter the appropriate name.
* **Value**: Enter the appropriate value.
* **Sensitive**: Select the checkbox if the value is sensitive.

<figure><img src="/files/DMy59Jj5FTAN0S9IqgiW" alt=""><figcaption></figcaption></figure>

Click **Save** to save the changes.

### FTP <a href="#ftp" id="ftp"></a>

![Save Connector](https://stg.ingestlabs.com/docs/images/customerdataplatformimages/connectorimagetwo.png) **Connect SFTP**

To connect SFTP, click **SFTP**. The following fields will be available:

* **Host Name**: Enter the hostname of the SFTP server.
* **Port Number**: Enter the port number for the SFTP connection.
* **User Name**: Enter the username for authentication.
* **Login Method**: Click the Login Method dropdown. You will see two options:
  * **Password**: Select this option if you want to authenticate using a password.
  * **Password Key**: Select this option if you want to authenticate using a password key.
* **Login ssh Private Key**: Enter the path to the ssh private key.
* **Login ssh Private Key Password**: Enter the password for the private key.

<figure><img src="/files/6GA3U9GU2pcNV38QXxQU" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/a1I5qLtAYWnySVbnAke6" alt=""><figcaption></figcaption></figure>

Click **Save** to save the changes.

### EMAIL <a href="#email" id="email"></a>

![Save Connector](https://stg.ingestlabs.com/docs/images/customerdataplatformimages/connectoremailone.png) **EMAIL SMTP**

To connect EMAIL SMTP, click **EMAIL SMTP**. The following fields will be available:

* **Host Name**: Enter the SMTP server hostname.
* **Port Number**: Enter the SMTP server port number.
* **Port Number**: Enter the SMTP server port number.
* **User Name**: Enter the username for SMTP authentication.
* **Login Password**: Enter the password associated with the SMTP username.
* **Sender Email ID**: Enter the email address from which the emails will be sent.

<figure><img src="/files/y9tJRVuPutRgmewsEzOn" alt=""><figcaption></figcaption></figure>

Click **Save** to save the changes.

![Save Connector](https://stg.ingestlabs.com/docs/images/customerdataplatformimages/connectoremailone.png) **Ingest Labs Email Sender**

Click the **Token** section to enter the appropriate details.

<figure><img src="/files/Xx4hGa92l6NWeGJdq3k7" alt=""><figcaption></figcaption></figure>

Click **Save** to save the changes.

![Save Connector](https://stg.ingestlabs.com/docs/images/customerdataplatformimages/connecterfacebookconnecter.png) **Connect Facebook OAuth**

To connect Facebook OAuth, click **Facebook OAuth**. The following fields will be available:

**API Version**: Click the **API Version** dropdown and select the appropriate version. Available options are:

* v17.0 - An earlier version that includes stable features but may lack the latest updates or improvements introduced in newer versions.
* v20.0 - A more recent version with enhancements, bug fixes, and potentially deprecated older features.

<figure><img src="/files/Q5tZcn82l5aNDd4ElTpf" alt=""><figcaption></figcaption></figure>

**Account ID**: Enter the Facebook account ID.

**Short Lived Token**: Enter the short-lived token for authentication.

<figure><img src="/files/EO7qsiPFpOCZJ51HETSZ" alt=""><figcaption></figcaption></figure>

Click **Save** to save the changes.

![Save Connector](https://stg.ingestlabs.com/docs/images/customerdataplatformimages/connecterfacebookconnecter.png) **Connect Facebook Conversion API**

To connect Facebook Conversion API, click **Facebook Conversion API**. The following fields will be available:

* **Pixel ID**: Enter the appropriate Facebook Pixel ID.
* **Token**: Enter the token associated with the Facebook Conversion API.

<figure><img src="/files/Dyce1vLNLQrIPLAZ2SIc" alt=""><figcaption></figcaption></figure>

Click **Save** to save the changes.

### Shopify <a href="#shopify" id="shopify"></a>

![Save Connector](https://stg.ingestlabs.com/docs/images/customerdataplatformimages/connecterspotify.png) **Shopify Personal Access Token**

To connect Shopify, click **Shopify** you will see the following field:

**Personal Access Token**: Enter the appropriate **Personal Access Token** for authentication.

<figure><img src="/files/CRlY6Kw2dUugaSTVLRXx" alt=""><figcaption></figcaption></figure>

Click **Save** to save the changes.

**Step 9**: Click **Metadata**.

<figure><img src="/files/iqd0qROm42D9doUopoxj" alt=""><figcaption></figcaption></figure>

**Step 9.1**: Click **Edit**.

<figure><img src="/files/SssDmNbJzGNl8vc8e9rW" alt=""><figcaption></figcaption></figure>

**Note:** You will see two fields labeled **Key** and **Value** on the screen, which can be edited.

**Step 9.2**: Click **Add** to add a new **Key** and **Value** field.

<figure><img src="/files/Hf27Habv4DzOgTFIWwoK" alt=""><figcaption></figcaption></figure>

**Note**: To remove a key-value pair, click the **Delete** button next to the pair you want to delete.

**Step 9.3**: Click **Save** to save the changes.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2F65KSBSENVGUa6WSylXDc%2FAdd%20a%20connector%20%20final.mp4?alt=media&token=56906a2f-5869-4309-a0e7-b734dc53f2e8>" %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ingestlabs.com/media-data-platform/connectors/add-a-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
