Knots Connector Setup

Why Do You Need a Connector?

Depending on the Knots app you're using, you would need to set up a connector to link your Knots instance (e.g., in Zendesk) with another external system.

For example:

• To export files to your SFTP server using the Export Tickets to PDF app, you will have to set up an SFTP connector. 

• Setting up a Shopify connector to call events from your Shopify Event Sync app

Below is a list of all the supported systems/platforms you can connect to. In the next section, you'll find detailed setup guides for each one of them.

Note: Some Knots apps are only compatible with specific connectors.

 

---

Available Systems

• Zendesk

• Generic

• Freshdesk

• Jira

• Shopify

• FTP

• SFTP

• Shopware v5

• Azure

• OpenAI

• PostgreSQL

• SharePoint

• Google

• AWS

• App Store Connect

• Dropbox

---

General Setup Instructions

To set up any connectors in Knots, follow these steps:

1. Log in to your Knots Connectors Dashboard.

2. In the upper part of the page, in the Connectors section, you'll see a list of your existing connectors.

3. Scroll down to the Add New Connector section.

4. Select the system you want to connect to from the system dropdown list (i.e., Zendesk, Jira, or Shopify).

5. Fill in the required fields as outlined in the guide below.

6. Click the Setup Connector button.

7. If you’re using Knots within an integration (e.g., Zendesk), return to your Knots app inside that platform to start using the connector.

Note: Once the setup is complete, your connector will be available for use in any Knots workflow that supports data sync, automation, or triggers.

 

---

Connector-Specific Setup Guides

Zendesk

Required fields:

• Connector Name

• Zendesk Subdomain – Your account's subdomain (e.g. yourcompany.zendesk.com → enter yourcompany).
  

---

Generic Connector

The Generic Connector allows you to connect to custom APIs or third-party systems not directly listed in the predefined connectors.

You can choose from the following authentication methods:

No Authentication

Choose this if the API or website you’re connecting to is open and doesn’t require authentication.

Required fields:

• Connector Name – A name for your reference (e.g., “Public Weather API”).

• Base URL – The root endpoint of the API or website (e.g. https://api.weather.com/v1).

Basic Authentication (default)

Use Basic Auth if the service requires a username and password for access.

Required fields:

• Connector Name

• Base URL

• Username

• Password

API Key

Use this method when the service requires an API key in the header.

Required fields:

• Connector Name

• Base URL

• API Key Header – The name of the header field (e.g. x-api-key).

• API Key – The key value provided by the service.

OAuth Token

OAuth is a secure token-based method that uses either the Password or Client Credentials grant types.

➤ If using password grant type:

Required fields:

• Connector Name

• Base URL

• Token URL – The endpoint to fetch the token.

• Grant Type – Select Password.

• Username

• Password

➤ If using client credentials grant type:

Required fields:

• Connector Name

• Base URL

• Token URL

• Grant Type – Select Client Credentials.

• Client ID

• Client Secret

Custom Token

Use this if you need full control over how the token is retrieved and passed to the target system.

Required fields:

• Connector Name

• Base URL

• Token URL – Where Knots should retrieve the token.

• Token Field – The key in the response that contains the token (e.g. access_token).

• Request Method – How the token should be requested (GET, POST, PUT, DELETE, PATCH).

• Headers (optional) – Any headers the token request requires (e.g. Content-Type).

• Request Body (optional) – JSON or form data needed to retrieve the token.

Example: If the token is retrieved via a POST request with username/password in the body, include those fields in JSON format in the request body section.

---

Freshdesk

Required fields:

• Connector Name

• Freshdesk Subdomain – (e.g. yourcompany.freshdesk.com → enter yourcompany).

• API Key – Found under your Freshdesk profile settings.
  

---

Jira

Required fields:

• Connector Name

• Jira Subdomain – (e.g. yourcompany.atlassian.net → enter yourcompany).
  

---

Shopify

Required fields:

• Connector Name

• Shopify Subdomain – (e.g. yourstore.myshopify.com → enter yourstore).

• API Key – Provided in the Shopify Admin > Apps > Manage private apps.
  

---

FTP

Required fields:

• Connector Name

• Base URL

• Username

• Password

• Port – Default 21 
  

---

SFTP

You can connect via Password or Private Key authentication (Connector type field).

➤ If using password option (default)

Required fields:

• Connector Name

• Base URL

• Username

• Password

• Port – Default 22

➤ If using private key option

Required fields:

• Connector Name

• Base URL

• Username

• Passphrase (if required for the private key)

• Port – Default 22

• Private Key – Paste the PEM-format private key here

---

Shopware v5

Required fields:

• Connector Name

• Shopware Domain

• Username

• Password
  
  

---

Azure

Required fields:

• Connector Name

• Base URL

• Token – Your Azure access token
  

---

OpenAI

Required fields:

• Connector Name

• Token – Your OpenAI API Key (e.g., from https://platform.openai.com/account/api-keys)
  

---

PostgreSQL

Required fields:

• Connector Name

• Base URL – The hostname or IP of your database server

• Username

• Password

• Port – The Default is 5432

• Database – Name of the database to connect to

Note: Password is required for access

---

SharePoint

Required fields:

• Connector Name

• SharePoint Subdomain – (e.g. yourcompany.sharepoint.com → enter yourcompany)
  

---

Google

Required fields:

• Connector Name
  
  

Note: Once selected, you'll be guided through Google OAuth to authorize access

---

AWS

Required fields:

• Connector Name

• Role ARN – ARN of the role Knots will assume
  Example: arn:aws:iam::123456789012:role/MyCrossAccountRole

  🛡 Knots Trusted Role ARN: arn:aws:iam::031390123923:role/knots-prod-CrossAccountAccessRole

• External ID (optional) – If your IAM role has an external ID configured
  

---

App Store Connect

Choose API Key authentication.

Required fields:

• Connector Name

• Issuer ID

• Key ID

• Private Key – Usually starts with -----BEGIN PRIVATE KEY-----
  

---

Dropbox

Required fields:

• Connector Name
  
  

Note: You'll be redirected to Dropbox to grant Knots access after connector creation

 

---

If you have any questions or suggestions, please reach out to us at support@knots.io or through our contact form.