連携

ChatWorkをCognoに連携する

ChatWork OAuth、Webhook登録、Cogno側の検証値保存、ChatWorkアカウントとworkspace memberの対応付けまでの流れです。

Integrations / ChatWork約6分

ChatWork連携は、OAuth接続とWebhook設定の2つで動きます。

OAuth接続は、CognoがChatWork APIを読むための認可です。認可したChatWorkユーザーが参加しているルーム、メッセージ、メンバー情報を使って、Cogno側の連携状態とUser mapping候補を作ります。

Webhook設定は、ChatWorkからCognoへメッセージイベントを届けるための設定です。ChatWorkのWebhook URLにCognoのURLを登録し、Cogno側にはWebhook Setting IDとWebhook Tokenを保存します。

事前確認

  • Cogno workspace の owner である。
  • ChatWorkで対象ルームに参加しているアカウントを使える。
  • ChatWorkのAPI管理画面でWebhookを作成、編集できる。
  • チーム共通の連携として運用する場合は、個人退職や権限変更で止まらないChatWork運用アカウントを使う。

CognoでOAuth接続する

  1. Cogno app を開きます。
  2. 対象 workspace の Integrations を開きます。
  3. ChatWork を選択します。
  4. Connect ChatWork を押します。
  5. ChatWorkの認可画面で、Cognoに許可するスコープを確認して承認します。
  6. CognoのChatWork連携ページに戻り、Connection が Connected になっていることを確認します。

ここまででCognoはChatWork APIを読めるようになります。リアルタイムのメッセージ通知を受けるには、次のWebhook設定も必要です。

ChatWorkでWebhookを作成する

  1. Cogno の Integrations > ChatWork を開きます。
  2. workspace owner にだけ表示される Webhook setupWebhook URL をコピーします。
  3. ChatWorkのAPI管理画面でWebhook設定を新規作成します。
  4. Webhook URL にCognoのWebhook URLを貼り付けます。
  5. Cognoに取り込みたいイベントを選びます。Cognoは message_createdmessage_updatedmention_to_me を取り込みます。
  6. ChatWork側でWebhook設定を保存します。

ChatWorkのWebhookは、ChatWork API管理画面から設定するリアルタイム通知です。公式仕様は Webhookについて を確認してください。

CognoにWebhookの検証値を保存する

  1. ChatWorkで作成したWebhook設定の編集画面を開きます。
  2. Webhook Setting IDWebhook Token を確認します。
  3. Cogno の Webhook setup に戻ります。
  4. Webhook Setting IDWebhook Token を入力します。
  5. Save webhook を押します。
  6. 表示が Webhook configured になったことを確認します。

CognoはこのIDとtokenを使って、届いたWebhookが対象workspaceのChatWork設定から来たものかを検証します。

User mappingを確認する

WebhookまたはChatWork APIからChatWork account候補が見つかると、User mapping に表示されます。

  1. Sync users を押して候補を更新します。
  2. 各ChatWork accountをCogno workspace memberに対応付けます。
  3. ChatWork上のメンションや投稿者が、Cognoのsemantic eventに入る前にworkspace memberとして解決される状態にします。

CognoからChatWorkへメンションを返す処理でも同じ対応関係を使います。ChatWork accountとCogno memberがずれている場合は、User mappingを先に直してください。

よくある状態

StateMeaningNext action
Webhook setup が表示されない自分がworkspace ownerではないworkspace ownerに設定を依頼します
Webhook not configuredCognoにWebhook Setting IDとWebhook Tokenが保存されていないChatWork側でWebhookを作成し、CognoにIDとtokenを保存します
User mappingが空ChatWork account候補がまだ見つかっていない対象ルームでメッセージを送るか、Sync usersを押します
メッセージがCognoに入らないOAuthだけ完了し、Webhookが未設定の可能性があるWebhook URL、イベント種別、ID/tokenを確認します

参照URL

関連docs

ChatWorkをCognoに連携する | Cogno