Registering a new client

The prebuilt Workato connectors are designed to cater to most of your business needs. However, there will be instances where you have a use-case with requirements that go beyond the scope of Workato's prebuilt connectors.

Why register a new client

In cases where the scope of the prebuilt connector is insufficient, you need to register a custom client with relevant scopes to satisfy your use-case.

This applies only to connectors that use OAuth 2.0 authentication. These connectors use OAuth 2.0 clients to interact with the API on behalf of your account, and usually have a fixed set of scopes attached to it. This means that the connector may not be able to interact with all the endpoints of an API.

Use custom clients with Workato connected apps

To use a custom client, you will need to create a custom connector. Use your custom client credentials with the HTTP universal connector or the SDK. This way, you can make use of the additional scopes from your custom client together with all the other connectors on Workato's platform.

Callback URL

Many cloud apps use OAuth 2.0 for authentication. Part of the OAuth 2.0 flow involves a callback URL (or Redirect URL). Use the callback URL https://www.workato.com/oauth/callback to complete the flow with Workato.

Some cloud apps, like Google, require you to register this callback URL at the point of client registration. It may also involve authorizing this URL. This is a security measure to prevent unwanted access to your account. If you do not register the callback URL, you may encounter an error like this.

400 Error. Redirect URI mismatch

Registering new client with callback URL

Let's go through an example of registering a new client on Google Cloud Platform.

Step	Description
1	Select Create credentials > OAuth client ID Google Cloud Platform API Credentials
2	Select Web application and fill in the following fields: Name Authorized redirect URIs Use https://www.workato.com/oauth/callback Create OAuth client ID
3	This is where most people encounter an Invalid Redirect message. To resolve this, select authorized domains list. If you do not encounter this issue (i.e. the callback URL is accepted), click Create and skip to Client credentials. Invalid redirect URL
4	You will be brought to the OAuth consent screen page. On this page, you will need to designate the following (steps 5-7): Application name Scope for Google APIs Authorized domain Alternatively, you can access this page from APIs & Services > Credentials > OAuth consent screen. OAuth consent screen
5	Copy Workato into Application name Application name
6	Select Add scope and copy the following scopes: - https://www.googleapis.com/auth/admin.directory.group - https://www.googleapis.com/auth/admin.directory.user Add scope
7	Copy workato.com into Authorized domains and click Save. Authorize Workato.com
8	Once again, select Create credentials > OAuth client ID Google Cloud Platform API Credentials
9	Select Web application and fill in the following fields: Name Authorized redirect URIs Use https://www.workato.com/oauth/callback Click Create. Accepted redirect URL
10	Done! You have created a custom client on Google Cloud Platform. New custom client

Retrieve client credentials

Now your custom client is ready to be connected to Workato. Open your custom client (for example, Workato) to view the client credentials. You will need the client ID and client secret for OAuth 2.0 authentication.

Client credentials

---

Frequently encountered problems

We noticed that some of our customers were misdirected to verify the domain http://www.workato.com on Google Cloud Platform like in the screenshot below.

Request to verify domain

This is not a required step. If you find yourself at this page, please circle back to APIs & Services > Credentials (Step 1).