Skip to main content
Creating an API client needs the API clients area of Workspace admin. If you cannot open it, ask whoever manages your Workato workspace to create the client for you.

Find your data center

The Data center is the region your Workato workspace runs in. A token works only against
the data center that holds the workspace, so pick the one that matches the address you sign
in to.

  • Sign in to Workato and read the host in your browser’s address bar.
  • app.workato.com: select US
  • app.eu.workato.com: select EU
  • app.jp.workato.com: select JP
  • app.sg.workato.com: select SG
  • app.au.workato.com: select AU
  • app.il.workato.com: select IL
  • app.uk.workato.com: select UK
  • app.kr.workato.com: select KR
  • app.workatoapp.cn: select CN
  • app.trial.workato.com: select Self-service (Trial), used by Workato Free and trial workspaces
  • Copy the matching region into StackOne Hub.

Create a client role

A client role lists the endpoints a token is allowed to call. Create one first, because every
API client has to be assigned a role when you create it.

1

Create the client role

Sign in to your Workato workspace at the address
of your data center, then open the client roles list:

  • Go to Workspace admin > API clients > Client roles.
  • Select Add client role.
  • Select the pencil next to New client role and enter a name such as StackOne Integration.
The Client roles tab of Workspace admin with the Add client role button highlighted
2

Select the endpoints the role allows

Endpoints are grouped under Projects, Tools and Admin. Open a group and tick
the endpoints the actions you use need. Each action names the endpoint it calls in its
description, so tick those and leave the rest clear.

  • Under Admin > Workspace collaborators > Collaborators, tick Get collaborators GET /api/members. The connection test calls this endpoint.
  • Under Admin > Workspace details > Workspace details, tick Get details GET /api/users/me to read the workspace the token belongs to.
  • Tick any other endpoint an action you use calls.
  • Select Save changes.
The Collaborators group expanded on the Admin tab with the Get collaborators endpoint highlighted

Create an API client

The API client holds the token. Assign it the client role you created, then copy the token it
generates.

1

Create the API client

Go to Workspace admin > API clients > API clients, then select
Create API client and fill in the form:

  • Name: StackOne Integration
  • Client role: the role you created
  • Project access: All projects, or the projects this token should reach
  • Allowed IPs: leave empty unless you restrict requests to known addresses
  • Select Create client.
The Create a new API client form showing the Name, Client role and Project access fields
2

Copy the API token

Open the client you created, then select the regenerate icon next to Cancel and
confirm with Regenerate token. Workato shows the token once.

  • Select Copy next to API token.
  • Copy the API token into StackOne Hub.
  • Select Done.
  • The token is shown only once and cannot be retrieved later. Regenerating it stops API calls that use the previous token.
The Regenerate API token dialog with the API token field and Copy button, token value hidden
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.