Webhook機能で別のWebアプリケーションへ連携する方法/「Chatwork」へ通知

最終更新日:

この記事では、「SATORI」のWebhook機能を用いて「SATORI」フォームに登録された情報をChatwork株式会社提供の「Chatwork」へ通知する方法の具体的な設定例をご案内します。

※Webhook機能については「Webhook」について をご参照ください。

attention.png 外部ツールの機能および設定詳細はサポート範囲外となります。あくまでも設定イメージをつかんでいいただくための一例であり、実際の設定に関するお問合せには対応しておりませんのでご了承ください。
また、本ページ内に、外部ツールのヘルプサイトへのリンクや画面キャプチャを使用していますが、参照先の仕様や画面は予告なく変更になる場合がございますこと、ご了承ください。

目次

  1. Chatwork」への通知
  2. 設定方法
  3. よくある質問/トラブルシューティング

 

1. 「Chatwork」への通知

「SATORI」フォームに登録された情報を「Chatwork」に通知させるための基本的な設定例をご紹介します。
ご利用の「Chatwork」側で、 API設定が必要です。
※ Chatwork API のご利用には、組織管理者様への申請が必要です。貴社組織内で事前に申請・承認のプロセスを完了いただいた上でご利用ください。

▼「Chatwork」への通知イメージ

webhook_cw_20200220_03.png

memo.png「Chatwork API」 とは ?

外部のプログラムからのデータを送信できる機能です。詳細は「Chatwork」のヘルプセンターの記事をご参照ください。
「Chatwork API ドキュメントサイト」 (外部サービスのサイトへリンクしています)

 

2. 設定方法

事前準備

① 「Chatwork API」の利用申請を済ませておきます
② 「Chatwork」のAPIドキュメントを確認しておきます
 「Chatwork API ドキュメントサイト」 (外部サービスのサイトへリンクしています) をご参照ください
③ 「Chatwork」へ通知したいフォームと項目を決めておきます

設定手順

以下が設定手順の概要です。

2-1. 「Chatwork」 の API Token を取得する
2-2. 「SATORI」 Webhook を設定する
2-3. 「SATORI」 Webhook を「SATORI」フォームにセットする
2-4. 「SATORI」フォームの登録情報が「Chatwork」に通知されるか確認する

以下に詳細をご案内します。

2-1. 「Chatwork」 の API Token を取得する

事前にAPIの利用申請が済んでいるアカウントで「Chatwork」の「API設定」を選択し、 API Token を取得します。
※「Chatwork」の「API設定」は、「Chatwork」の画面右上、ユーザー名横の「▼」からメニュー表示が可能です。
※以下画面でパスワードを入力し、「表示」ボタンをクリックすると発行されます。
※発行された API Token は第三者に開示しないようご注意ください。
※手順2-2で、Header情報として設定します

webhook_cw_20200220_01.png

2-2.「SATORI」 Webhook を設定する

左カラムメニュー [コンテンツ] > [Webhook] > 「Webhook リスト」画面右上の「+」ボタンから「新規Webhook作成」を開いて Webhook の設定を行います。設定する内容は、「Chatwork」の APIドキュメントに従ってください。

webhook_cw_20200220_02.png

  • 「URL」には Chatwork API のエンドポイントを貼り付けます
    任意のチャットルームに新しいメッセージとして通知する場合は以下のURLを指定します
    https://api.chatwork.com/v2/rooms/{room_id}/messages
    必ず https で接続する必要があります。
    ※ {room_id} は通知したいチャットルームのIDを取得の上、置換して登録してください。
    ※ {room_id} は、チャットルームの”管理者”が確認可能です 。
    チャットルームの”管理者”として該当ルームを開き、画面右上の歯車マークから「グループチャットの設定」を表示することで確認できます。”メンバー”の場合は対象のチャットルームの”管理者”へご確認ください。
  • 「Method」は「Chatwork」の指定に従い「POST」を選択します
  • 「Parameter」は以下サンプルのように JSON形式で設定します
    「利用できる特殊変数」を活用することにより、通知内容にカスタマー情報やフォーム登録内容を反映させることができます
    ▼サンプル
    {
      "body": "●●セミナーのお申込みフォームから{{company}}の {{name}}様の登録がありました。SATORIのカスタマー詳細ページは{{customer_detail_url}}です。",
      "self_unread": "1"
    }
  • は「Chatwork」の指定に従い「application/x-www-form-urlencoded」を選択します
  • 「Header」は「Chatwork」の指定に従い以下サンプルのようにJSON形式で設定します
    「xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx」には「2-1. Chatwork の API Token を取得する」で取得した API Token を記載します
    ▼サンプル
    {
    "X-ChatWorkToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }

2-3.「SATORI」 Webhook を「SATORI」フォームにセットする

2で作成した「SATORI」 Webhook を「SATORI」フォームにセットします。
設定方法詳細は「Webhook」について > 2-2. 「SATORI」フォームに Webhook をセット をご確認ください。

2-4. 「SATORI」フォームの登録情報が「Chatwork」に通知されるか確認する

Webhook をセットした「SATORI」フォームの登録情報が、意図したとおりに「Chatwork」に通知されるか確認します。

本記事で設定例としてご案内した設定により、該当フォームからの登録があれば以下のように「Chatwork」の該当ルームに通知されます。

webhook_cw_20200220_03.png

  • 株式会社■■■」には、SATORIの特殊変数 {{company}} によって、フォームに登録されたカスタマーの「会社名」が反映されます
  • 〇〇〇〇〇〇」には、SATORIの特殊変数 {{name}} によって、フォームに登録されたカスタマーの「氏名」が反映されます
  • xxx... 」には、SATORIの特殊変数 {{customer_detail_url}} によってフォームに登録されたカスタマーの「SATORI」上の「カスタマー詳細ページのURL」が反映されます

 

3. よくある質問/トラブルシューティング

この記事の内容については、基本的にはサポート範囲外となりますこと、ご了承ください。

  • 「SATORI」 Webhook の設定については本記事でご案内した内容通りの設定を反映してください。「Parameter」の内容のカスタマイズなどは任意です
  • Chatwork」側の設定については、「Chatwork」のAPIドキュメント、「Chatwork」のサポートサイト、関連キーワードのウェブ検索結果などをご参考にご確認ください
  • 「Chatwork」側への通知が確認できない場合、左カラムメニュー [アクション] > [Webhook履歴] >対象の履歴の [︙]から、該当の履歴の詳細を確認してください
    「送信ステータス」が "error" になっている(※)
    「レスポンスコード」が ”400” など、エラーコードが表示されている
    「レスポンスボディ」にエラーメッセージが返されている
    などの履歴詳細から、エラーの原因をある程度特定できます
    ※「送信ステータス」が "error" となるケースは、「URL」に特殊変数を埋め込んだためにそもそも送信できないURLになった場合、などに起こり得ます
  • 「Webhook」について の よくある質問/トラブルシューティング もあわせてご確認ください

 

※ 記載している会社名、商品名は各社の商標または登録商標です。

この記事は役に立ちましたか?

1人中1人がこの記事が役に立ったと言っています