Add a Connector
Last updated
Last updated
To add a new connector, follow these steps:
Step 1: In the left navigation panel, click Connectors.
Step 2: Click Add New Connector located at the top-right corner of the screen.
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.
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.
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.
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 to add Connector Types.
Step 8: The Select Connector Type list opens on the right. Select the appropriate connector type.
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.
Note: Fields marked with an asterisk (*) are mandatory.
Click Save to save the changes.
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.
SSL: Specify if SSL is required for the connection.
True - nables 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
Click Save to save the changes.
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.
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.
Click Save to save the changes.
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.
Click Save to save the changes.
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.
Click Save to save the changes.
Click the Token section to enter the appropriate details.
Click Save to save the changes.
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.
Account ID: Enter the Facebook account ID.
Short Lived Token: Enter the short-lived token for authentication.
Click Save to save the changes.
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.
Click Save to save the changes.
To connect Shopify, click Shopify you will see the following field:
Personal Access Token: Enter the appropriate Personal Access Token for authentication.
Click Save to save the changes.
Step 9: Click Metadata.
Step 9.1: Click Edit.
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.
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.
AWS IAM Role
Postgres credentials
API Keys
Connect SFTP
EMAIL SMTP
Ingest Labs Email Sender
Connect Facebook OAuth
Connect Facebook Conversion API
Shopify Personal Access Token
