Configure Connection

Teamwork Desk guide

Create a Teamwork Desk API key, configure the tenant URL and token in NIM, and test access by retrieving companies.

Before you startDirect link to Before you start

Follow the Teamwork Desk API getting started guide to create an API key. API access follows the permissions of the Teamwork Desk user associated with the key.

NIM requires Tenant URL and Token.

Prepare API accessDirect link to Prepare API access

Sign in to Teamwork Desk with the account whose permissions will be used for the integration.
Open your avatar menu and select View Profile > API Keys.
Select Create an API key and copy the generated key securely for use as the NIM Token.
Confirm the Teamwork Desk API URL for your environment and the account's access to tickets, customers, and companies.
Confirm that the account can perform the intended customer and company management operations.

Enter the connection settingsDirect link to Enter the connection settings

In NIM Studio, open Systems > Overview and add a Teamwork Desk system, or select the existing system.
Open its Connection screen.
Enter the following settings and save the connection.

NIM setting	Value
Tenant URL	The Teamwork Desk API tenant URL for your environment. Use the correct regional or custom domain and the API base path expected by the connector.
Token	The API key created in the Teamwork Desk user's profile.

Test company accessDirect link to Test company access

Select Test Connection. NIM calls this endpoint using the configured Tenant URL:
```
GET /v2/companies.json
```
The request retrieves a list of companies.
Confirm that the test succeeds. If it fails, verify the Tenant URL and API base path, API key, and associated user's permissions.
Collect the system and inspect tickets, ticketActivities, customers, and companies for your process.
Validate the collected ticket data before using it in NIM filters and reports.
Validate intended customer and company creation, updates, and deletion with safe test records before enabling automation.

The connection test reads companies. Validate ticket and customer collection, and each intended write operation, separately.

Step 1 of 3