Sign inGet started
Docs
Get started

HelpDesk API Authentication

How to authenticate HelpDesk API requests: one Bearer API key plus a connectionId. MindCloud stores your HelpDesk credentials — no auth headers to build.

Every HelpDesk API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your HelpDesk 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 HelpDesk connection in Connections. HelpDesk uses a username and password. You enter them when you create the connection — MindCloud stores them securely so your requests never carry raw credentials.
  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 HelpDesk account that should run the action. MindCloud stores and refreshes the HelpDesk 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 List Tickets with an HelpDesk connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/helpDesk/actions/list-tickets/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 HelpDesk account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect HelpDesk with Account ID and PAT

You need access to the Text Developer Console. A Personal Access Token is shown only once when you create it.

  1. Open the Text Developer Console

    Sign in with the HelpDesk account that owns the workspace and open the developer console.

    Developer Console
  2. Open Personal Access Tokens

    Go to the Personal Access Tokens screen in the developer console.

    Developer Console → Tools → Personal Access Tokens
  3. Create a token with the documented HelpDesk scope

    Create a new token and include the documented `accounts--my:ro` scope.

  4. Copy the token and your account ID

    Copy the Personal Access Token immediately, then copy the `account_id` value shown in the developer console.

  5. Return to MindCloud and fill the credentials

    Paste the `account_id` into the Username field and the Personal Access Token into the Password field.

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.