Chatwork API Authentication

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

Every Chatwork API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Chatwork 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

Create a MindCloud account at app.mindcloud.co if you do not already have one.
Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
Create a Chatwork connection in Connections. Chatwork uses OAuth. When you create the connection, you are redirected to sign in to Chatwork and approve access — MindCloud stores the resulting tokens and refreshes them automatically, so your integration never has to.
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 Chatwork account that should run the action. MindCloud stores and refreshes the Chatwork 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 My Profile with an Chatwork connection looks like this:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/chatwork/latest/actions/get-my-profile" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

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

Connect Chatwork

MindCloud uses the configured Chatwork OAuth2 client for this connection.

Start the OAuth flow
Click Connect in MindCloud to open the Chatwork authorization screen.
Approve the requested scopes
Sign in to Chatwork if prompted, then approve the requested read and write scopes for the configured client.

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.