Sign inGet started
Docs
Get started

Deskpro API Authentication

How to authenticate Deskpro API requests: one Bearer API key plus a connectionId. MindCloud runs the OAuth flow and refreshes Deskpro tokens for you.

Every Deskpro API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Deskpro account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a Deskpro connection in Connections. Deskpro uses OAuth. When you create the connection, you are redirected to sign in to Deskpro and approve access — MindCloud stores the resulting tokens and refreshes them automatically, so your integration never has to.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Deskpro account that should run the action. MindCloud stores and refreshes the Deskpro credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling Get Current User with an Deskpro connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/deskpro/actions/get-current-user/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Deskpro account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect Deskpro OAuth2

You need a Deskpro helpdesk URL and a Deskpro OAuth client with authorization code flow enabled.

  1. Open Deskpro OAuth settings

    In Deskpro, go to Admin -> Apps & Integrations -> OAuth and open the OAuth client you want MindCloud to use.

  2. Copy the tenant-specific OAuth details

    Copy the Helpdesk URL root, Auth endpoint, Token endpoint, Client ID, and Client Secret from the OAuth client details screen.

  3. Confirm the redirect URL

    Make sure the Deskpro OAuth client allows the MindCloud redirect URL https://api.mindcloud.co/v1/oauth/deskPro/callback.

  4. Enter the helpdesk URL in MindCloud

    Set Helpdesk URL to your Deskpro root URL without a trailing slash, for example https://your-helpdesk.deskpro.com.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.