Docs

Edworking API Authentication

How to authenticate Edworking API requests: one Bearer API key plus a connectionId. MindCloud stores your API key securely — set it once, never resend it.

Every Edworking API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Edworking 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 Edworking connection in Connections. Edworking uses an API key. You generate the key in your Edworking account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
  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 Edworking account that should run the action. MindCloud stores and refreshes the Edworking 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 Notifications with an Edworking connection looks like this:

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

Create a personal Edworking API token

You need an Edworking user account with access to the workspace you want to connect.

  1. Open Preferences in Edworking

    Log in to Edworking, open the avatar menu in the top-right corner, and choose Preferences.

  2. Open the Admin tab

    In Preferences, open the Admin tab where Edworking shows the personal API token controls.

  3. Copy your API token

    Under API Token, click Copy Token and paste that value into the MindCloud connection form.

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.