How-to guides

Connect ConnectWise PSA

Create a Security Role and an API Member in ConnectWise, then paste four fields into DarkBird.


To connect ConnectWise you need to create a Security Role and an API Member in your ConnectWise instance.

Step 1 — Find your Company ID and API URL

Your Company ID is the short identifier you use at the ConnectWise login screen (e.g. mycompany). It also appears in the browser URL after login: …/login.aspx?companyName=mycompany.

The API URL depends on your hosting region — note the api- prefix, easy to drop by mistake:

RegionAPI URL
North America (default)https://api-na.myconnectwise.net
Europehttps://api-eu.myconnectwise.net
Australia / Asia-Pacifichttps://api-au.myconnectwise.net
Staging / sandboxhttps://api-staging.myconnectwise.net

Step 2 — Create a Security Role

  1. System → Security Roles

    Click the + icon to add a new role.

  2. Name it

    Call it DarkBird API.

  3. Set module permissions

    Use the table below — Delete is never required for any module.

  4. Save

    Click Save to create the role.

ModuleFunctionAddEditDeleteInquiry
CompaniesMaintenance / ContactsNoneNoneNoneAll
ProcurementProduct CatalogNoneNoneNoneAll
ProjectHeaders / Management / Phase / Tickets / ProductsAllAllNoneAll
ProjectProject FinanceNoneAllNoneAll
SalesOpportunitiesAllAllNoneAll
Time & ExpenseTime EntryNoneNoneNoneAll

Step 3 — Create an API Member

  1. System → Members

    Click the API Members tab, then the + icon.

  2. Fill in the member details

    Member ID: DarkBirdAPI. Member Name: DarkBird Integration. Role ID: the DarkBird API security role you created above. Level: Corporate.

  3. Save

    Click Save.

Step 4 — Generate API keys

  1. Open the API Keys tab

    On the API Member record, click API Keys, then the + icon to generate a new key pair.

  2. Describe the key

    Enter a description, e.g. DarkBird, and Save.

  3. Copy both keys immediately

    The Private Key is shown only once and cannot be recovered after you navigate away.

Step 5 — Enter credentials in DarkBird

Go to Settings → Integrations → ConnectWise and click Connect. Fill in all four fields:

FieldWhere to find it
Company IDThe short name used at the ConnectWise login screen
API URLRegional URL from the table above (defaults to North America)
Public KeyShown on the API Keys tab after generating
Private KeyShown once when the key pair is first generated — copy before leaving the screen
Tip

Delete permission is not required for any module — DarkBird never deletes records in your PSA. Service Desk permissions aren't required either: DarkBird only ever touches ConnectWise Project Tickets, never Service Desk tickets.

What DarkBird does in ConnectWise

  • Link the opportunity — In the Estimate phase strip, click Link opportunity and pick the existing ConnectWise opportunity. The opportunity is the hub for the project. DarkBird never creates opportunities in ConnectWise — create it there first if it does not exist. When you start a new project from the ConnectWise tab, the same picker applies and the client and site data pull in automatically.
  • Push the quote — When Settings → Integrations → Quoting is set to ConnectWise, Push to ConnectWise opportunity adds your BOM as product lines and a total labor summary line to the linked opportunity. Products synced from ConnectWise are matched by catalog identifier; manually-entered products appear as description-only lines. ConnectWise has no separate quote object here, so a second push adds the lines again.
  • Sync Plan to ConnectWise — On the Deliver tab, push the WBS to the linked project. Each DarkBird phase becomes a project phase; each task becomes a project ticket with budget hours. If the DarkBird project is still linked to the opportunity, use Link won project in the Deliver strip first to pick the ConnectWise project the opportunity became.
  • Pull actuals from ConnectWise — in the Review phase, pull time entries logged against the project tickets. Hours populate the Actuals column for calibration.
  • Product Catalog Sync — Automatically runs on first connect and can be re-run from Settings → Integrations → ConnectWise → Sync Products.
Tip

After winning an opportunity in ConnectWise and converting it to a project, use Link won project in the Deliver strip to pick that project before syncing the WBS. DarkBird keeps the opportunity id alongside it.