権限とデータの扱い
HubSpot の権限・LINE WORKS 側の権限・保存するデータ
新規導入
アプリが HubSpot と LINE WORKS に求める権限と、保存するデータ・保存しないデータを説明します。
HubSpot に要求する権限(スコープ)と、足りないときの表示
アプリは、レコードの読み取り・担当者の読み取り・紐付けの保存に必要な権限を要求します。要求する権限は、この記事の表で全部です。
権限の一覧
| 権限 | 使い道 |
|---|---|
crm.objects.contacts.read、crm.objects.companies.read、crm.objects.deals.read、crm.objects.tickets.read | ワークフローとカードの対象レコードの情報の読み取り |
crm.objects.owners.read | 宛先「レコードの担当者」の、担当者のメールアドレスの取得。カードの送信者の名前の取得 |
crm.objects.contacts.write、crm.objects.companies.write、crm.objects.deals.write、crm.objects.tickets.write | ルームの紐付けの保存(プロパティの値の書き込み) |
crm.schemas.contacts.write、crm.schemas.companies.write、crm.schemas.deals.write、crm.schemas.tickets.write | 紐付けに使うプロパティとプロパティグループの作成 |
oauth | HubSpot との接続の確立 |
権限が足りないとき
- アプリの更新で権限が増えた場合は、HubSpot の欄に「再接続」が表示されます。
- 「権限が足りません」「一部の機能が動きません。再接続してください。」と表示され、再接続すると解消します。
- ワークフローでは「OWNER_LOOKUP_FAILED」、カードの紐付けでは「設定画面の接続のタブで HubSpot に接続してください」と表示されることがあります。
要求しないもの
メールやメモの読み書き、ワークフローの作成・編集の権限は要求しません。
-
対処
再接続の手順は「HubSpot の欄に「HubSpot と接続できません」と表示される」をご覧ください。
LINE WORKS 側で必要な設定と権限
LINE WORKS 側では、専用のアプリと、公開した Bot が必要です。作業は管理者権限のあるアカウントで行います。
必要な設定
| 項目 | 内容 |
|---|---|
| アプリ | Developer Console で作成します。Client ID と Client Secret を使います。専用のアプリを推奨します。 |
| スコープ | 「bot」と「user.read」の2つだけです。 |
| 接続の方法 | サービスアカウント(Service Account ID と Private Key)、またはログイン(Redirect URL の登録と Refresh Token Rotation の ON)。 |
| Bot | Developer Console で作成します。Bot ID と Bot Secret を使います。 |
| Bot の公開 | 管理者画面の「サービス」>「Bot」で追加し、メンバーが使えるように公開します。 |
| トークルームへの通知 | Callback URL の有効化、Join Event と Leave Event の選択、「複数人のトークルームに招待可能」の有効化。 |
LINE WORKS のプランと利用範囲
- LINE WORKS のプランは、フリープランを含め、すべてのプランで利用できます。
- 通知を送れるのは、社内のメンバーと、Bot が参加している社内のトークルームです。社外のユーザー(LINE ユーザー・他社の LINE WORKS ユーザー)を含むトークルームでは、LINE WORKS の仕様上、Bot を使えません。
LINE WORKS の API の利用上限
LINE WORKS の API には、1分あたりの呼び出し回数の制限があります。上限は LINE WORKS のプランによって異なり、超えると、混み合っているという扱いになります。自動で再実行される動きは「混雑・一時的な障害のときの自動再実行」をご覧ください。
-
手順
作成の手順は「Developer Console で LINE WORKS のアプリを作る」と「Bot を作成し、管理者画面の「サービス」>「Bot」で公開する」にまとめています。
アプリが保存するデータ・保存しないデータ
メッセージの本文や宛先メンバーの情報は保存しません。保存するのは、接続に必要な情報、登録したルーム、契約と送信数の情報です。
保存する情報
| 情報 | 内容 | 扱い |
|---|---|---|
| LINE WORKS の接続情報 | Client ID、Service Account ID、Bot ID、各 Secret・秘密鍵、トークン | 秘密の値は暗号化して保存します。画面には再表示しません。 |
| HubSpot の接続情報 | HubSpot のトークンと許可された権限 | トークンは暗号化して保存します。許可された権限の一覧は暗号化せず保存します。 |
| 登録したルーム | チャンネル ID・ルーム名・登録元(自動・手動) | ルームの一覧を取得できる仕組みが LINE WORKS にないため、保存しています。 |
| 契約と送信数 | プラン・契約の状態・次回の更新日・今月の送信数 | 上限の判定と画面の表示に使います。 |
保存しない情報
- メッセージの本文
- 宛先のメンバーの情報(一覧は、必要なたびに LINE WORKS から取得します)
- 送信の履歴
- HubSpot ユーザーと LINE WORKS ユーザーの対応表
ルームの紐付け
紐付けの情報は、アプリではなく、HubSpot のレコードのプロパティに保存されます。
削除のタイミング
- 接続の解除: 認証情報とトークンをその場で削除します。
- アンインストール: 認証情報・トークン・登録したルームを、通常1日以内に削除します。
-
詳しい手順
解除とアンインストールの違いは「アンインストールする(接続の解除との違い)」にまとめています。