できること

接客サービスとしてWebhookを登録することで、外部サービスに対してリアルタイムにデータを送信することができます。※エンジニアスキルが必要となります。

必要な作業

  • Webhookプラグインをインストールする
  • Webhookの接客サービスを配信する

Webhookプラグインをインストールする

ご利用ご希望の方は、サポートまでお問い合わせください。

Webhookの接客サービスを配信する

1. Webhook接客サービスを新規作成する

Webhookプラグインをインストールすると、接客サービスの新規作成時に「他サービスにデータを連携する」というメニューが表示されますので、そちらを選択します。

対象ユーザーに、適切なセグメントを設定します。

2. Webhook接客サービスのアクションを設定する

以下の変数を、リクエスト内容に合わせて設定します。

  • target_url

    • リクエスト先URL
  • method

    • GETやPOST
  • body

    • リクエストbody
    • 4.3 で トリガーに設定したイベントのフィールドの値や、その他 合わせて送信したいイベントのフィールドの値は、ユーザー情報変数を用いてbodyに含めることが可能です
    • ユーザー情報変数は、「変数・ユーザー情報変数」利用方法・仕様をご参考下さいませ
    • 一部、送信対象に指定できない情報がある場合がございます。詳細は、KARTEサポートにお問い合わせ下さい
  • Content-Type

    • Content-Typeヘッダの値
  • retry

    • webhookがエラーになったときのリトライ設定
    • webhookのリクエスト先のサーバーが原因で失敗した場合にリトライするかを選択できます。詳細については「4. webhookのリトライの仕様」をご確認ください。

3. 対象イベントを設定する

Webhookアクションが実行されるトリガーを設定します。

必要なイベント以外ではトリガーされないようにしてください。

  • 例: KARTE TALKのメッセージ返信の日付(unixtime)をWebhookで送る場合

  • message_reply(メッセージに返信) の 送信日時 が 存在する

4. webhookのリトライの仕様

webhookアクション設定でretryにチェックを付けるとwebhookがエラーで失敗した場合に再度webhookのリクエストを送信します。

リトライ詳細

リトライタイミング

リクエストを送信したときにリクエスト先から500番台のエラーが返ってきたときにリトライを実行します。
400番台のエラーが返ってきた場合などはリトライは実行されません。

リトライ回数とリトライ間隔

リトライ回数は最大3回です。最初の実行を含めると最大4回実行されます。
各リトライの間隔は5秒、25秒、125秒の間隔で実行がされます。

リトライ失敗のお知らせ通知

リトライを3回行ってそれでもエラーが返ってくる場合、もしくは500番台以外のエラーでwebhookが歯っぱ視してしまった場合はお知らせに通知されます。
エラーを確認したい場合はお知らせにある「webhook - 実行失敗」をご確認ください。

ユースケース

チャットメッセージをWebhookで送信する

4.3 でチャット関連のイベントを対象イベントして設定している場合、チャット関連のイベントの中身(会話内容など)をWebhook経由で外部サービスに送信することができます。

代表的なイベントと、イベントの内容(パラメータ)を以下に記します。

  • talk_message_send イベント(オペレーターのチャット発言)
    • content.text(チャットでの会話内容)
  • message_reply イベント(エンドユーザーのチャット発言)
    • content.text(チャットでの会話内容)

それぞれ、ユーザー情報変数で定義した上で リクエストbody内で指定すれば、オペレーターのチャット発言がWebhook経由で外部サービスに送信されます。
(※注 プライバシーの問題で、一部のイベント情報の送信が制限されている場合がございます。現時点で送信可能な情報については、チャットサポートにお問い合わせくださいませ。)

チャットで発生するイベントの定義については、以下のドキュメントをご確認ください。

その他