AdminアカウントでCustom OAuth profileを作成する ​

このガイドでは、Adminワークスペースでアプリケーション用のCustom OAuth profileを作成する方法について説明します。 このプロセスは、顧客ワークスペースにCustom OAuth profileを適用するための前提ステップです。

このガイドではHubSpotを例として使用しますが、Workatoがサポートするその他のアプリ向けに追加のカスタムプロファイルを作成する場合にも使用できます。 アプリケーションに関係なく、WorkatoでCustom OAuth profileを作成するプロセスは同じです。 ただし、アプリケーションでOAuthプロファイルを登録するプロセスは、アプリケーションによって異なる場合があります。 Custom OAuth profileを作成できるアプリケーションの一覧については、Embeddedパートナー向けCustom OAuth profilesドキュメントを参照してください。

Custom OAuth profileには、接続先アプリケーション内のOAuthアプリが必要です。 そのアプリケーションでアプリを作成し、その認証情報をWorkatoに入力します。

前提条件 ​

HubSpot OAuthアプリを作成するにはHubSpot CLIが必要であり、HubSpot CLIにはNode 20以降が必要です。 npm install -g @hubspot/cliでCLIをインストールし、hs account authで認証します。これによりブラウザーでHubSpotが開き、個人用アクセスキーが生成されます。 設定手順については、HubSpot CLIのインストールドキュメントを参照してください。

HubSpotアプリを作成する ​

HubSpotでOAuthアプリを作成するには、次の手順を実行します:

cd PROJECT_DIRECTORY

{
  "uid": "workatocustomoauth_app",
  "type": "app",
  "config": {
    "name": "workato custom oauth-App",
    "description": "Custom OAuth profile for the Workato HubSpot connector.",
    "distribution": "private",
    "auth": {
      "type": "oauth",
      "redirectUrls": ["https://www.workato.com/oauth/callback"],
      "requiredScopes": ["oauth", "crm.objects.contacts.read"],
      "optionalScopes": []
    },
    "permittedUrls": {
      "fetch": ["https://api.hubapi.com"],
      "iframe": [],
      "img": []
    }
  }
}

hs project upload

hs project open

詳細については、HubSpotのCLIを使用して新しいアプリを作成するガイドを参照してください。

Workatoでプロファイルを作成する ​

WorkatoでCustom OAuth profileを作成するには、次の手順を実行します。

コネクションの詳細 ​

プロセスのこの時点では、作成したCustom OAuth profileは、それを作成したワークスペースでのみ機能します。

作成したカスタムプロファイルは、ユーザーがCustom OAuth profileが存在するコネクションを選択したときに、標準のWorkatoコネクションを自動的に置き換えます。

コネクション内のCustom OAuth profileフィールドは、ユーザーが次のいずれかに該当する場合にのみ表示されます：

• Custom OAuth profiles機能へのアクセス権がある、または
• そのアプリのCustom OAuth profileを作成している