ConnectWise PSA: prepare a read-only API member

StatusComing soon

Short answer: in ConnectWise PSA, create a security role that can only inquire (view) in the modules StackTether will read, create an API Member under System > Members with that role, and generate a public and private API key pair on the member. The private key is shown only once.

What you need

• A ConnectWise PSA admin who can edit security roles and members.
• Your ConnectWise company ID (the one you type when you sign in) and your site address (for example api-na.myconnectwise.net for North American cloud).

Step 1: create an inquire-only security role

1. Go to System > Security Roles and add a new role, for example "StackTether Read-Only".
2. For each module, set only Inquire Level (view). Leave Add, Edit and Delete at None.
3. Give inquire access to the data StackTether's PSA tools read. In ConnectWise these items sit under modules such as Companies, Service Desk, Project, Time & Expense, Finance and System; the exact item names depend on your version:
   • Service tickets, their notes and the time on them
   • Companies, their sites, contacts and company notes
   • Configurations (assets)
   • Projects, phases and project tickets
   • Time entries (used to show each tech their own time)
   • Schedule entries (dispatched visits)
   • Agreements (names, dates and status only; StackTether never shows prices)
   • Table setup, so status, priority and board names can be read
4. Leave invoice, billing, procurement and sales items at None unless one of the items above needs inquire there.

Step 2: create the API member

1. Go to System > Members and open the API Members tab.
2. Add a new API member, for example "StackTether", fill in the required fields and choose the security role from step 1.
3. Save. API members are the member type ConnectWise provides for integrations.

Step 3: generate API keys

1. Open the new API member and go to its API Keys tab.
2. Add a key with a description such as "StackTether" and save.
3. Copy the public key and private key into your password manager straight away. ConnectWise shows the private key only once.

Official documentation

• ConnectWise Developer Network: ConnectWise PSA (free sign-in required). It covers authentication with your company ID, public key and private key, and the developer client ID ConnectWise requires on API calls.
• ConnectWise documentation: search for "API Members" and "Security Roles" for your version.

Rotate and revoke

• Rotate: add a new key pair on the API member, replace it in StackTether, then delete the old key.
• Revoke: delete the API key or deactivate the API member.

FAQ

Can I use an existing member's keys?

Do not. Keys on a person's member act with their full role and stop working when they leave. Use a dedicated API member.

When will ConnectWise PSA be available?

It is in the first group of new vendors. To be told when it opens, use the contact form.