ウェブフック

ウェブフック

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

SalesIQ Webhook の概要

Webhook は「イベントリアクション」というコンセプトに基づいて動作し、クライアント側アプリケーションがサーバー側アプリケーションを継続的にポーリングする必要をなくします。つまり、クライアント側アプリケーションがサーバー側アプリケーションに新しい処理があるかどうかを常に確認する代わりに、サーバー側アプリケーションが何か新しい報告事項がある場合、クライアントが指定した Webhook URL を通じてクライアント側アプリケーションに通知します。これが Webhook の基本的な仕組みです。

メリット

  1. Webhook を利用すると、サーバーで特定の処理が発生した際に、プッシュ通知を受け取ることが可能です。API を定期的にポーリングしてこれらの処理の発生を確認する必要はありません。Webhook でイベントに「サブスクリプション管理」するだけで済みます。
  2. Webhook は自動化や業務効率向上に活用できる強力なリソースです。API リソースが必要に応じて作成・更新・取得できる静的データであるのに対し、Webhook は動的リソースです。たとえば、顧客が会話を開始または返信した際など、特定の操作があった場合に自動的に通知されるよう設定できます。

Webhook の作成と管理

REST API を利用して Webhook の作成および管理が可能です。詳しくはこちら。

信頼できるデータ元の検証（署名による）:

公開鍵とは何か、API を使ってどのように生成するか
SalesIQ は、エンドポイント URL に送信される Webhook イベントごとに RSA 暗号方式を用いて署名します。
  1. SHA256 with RSA を署名アルゴリズムとして使用しています。
  2. 署名は Base64 でエンコードされます。
  3. 使用している文字セットは UTF-8 です。
生成した公開鍵はコピーしてエンドポイントサーバーに保存でき、後で署名付きで受信したデータの真正性を確認するために利用します。公開鍵と秘密鍵のペアが生成されます。
公開鍵を生成するには、以下の API を利用してください。
  1. API: /api/v2/{screenname}/Webhook/{id}/keys
  2. METHOD：POST
  3. Scope：SalesIQ.Webhook.作成
公開鍵を削除するには、以下の API を利用してください。
  1. API: /api/v2/{screenname}/Webhook/{id}/keys/{keyid}
  2. METHOD：削除
  3. Scope：SalesIQ.Webhook.削除
信頼できるデータ元の検証は、Webhook のセキュリティ確保のために行います。これは、統合サービスであるあなたが、API レスポンスで受け取った公開鍵と、そのデータに付与された x-siqsignature リクエストヘッダー内の署名を検証することで、SalesIQ サービスから送信されたデータであるかどうかを認証するものです。署名が有効であれば、そのデータ元は信頼できます。このプロセスにより、Webhook を不正アクセスから保護します。

署名ヘッダーを利用してデータ元を認証するには：
  1. ヘッダー :
  2. {
  3. x-siqsignature : $署名
  4. }
セキュアなコールバックを設定したい場合は、Webhookを作成し、「secured:真」としてセキュアを設定してください。
  1. データの内容:
  2. {
  3. Webhook : {
  4. url : $webhookurl,
  5. secured : },
  6. 公開済み :
  7. }
Notes
メモ:
  1. 1ポータルあたり許可される管理者Webhookの最大数は3です。
  2. Webhookの自動再試行回数の上限は3回です。
  3. 自動再試行は、次の再試行まで1分間隔で行われます。
  4. 各実行のタイムアウトは5秒です。
  5. 初期設定のエラーログ保持期間は60日です。
  6. Webhookはエンタープライズプランでのみご利用いただけます。

Webhook データの内容

SalesIQで購読しているイベントが発生すると、Webhookが呼び出されます。例えば、conversation。visitor。repliedに購読している場合、訪問者がチャットに返信すると関連データとともに通知されます。

データの内容の定義:

  1. バージョン - Webhookデータの内容のバージョン
  2. event - 通知されたイベント
  3. event_time - イベントが発生した時間
  4. org_id - お客様のSalesIQポータルID
  5. app_id - 埋め込みID。データ処理のみ利用可能
  6. attempt - Webhookを通じてイベント通知を試行した回数
  7. 項目 - 発生したイベントの項目
  8. entity_type - 項目の種類（例：Bot、部署、オペレーター）
  9. entity_id - 項目のユニークID。例えば、conversation.*処理の場合は会話ID
  10. modified_fields - 更新されたプロパティの一覧
データの内容は以下の形式で受領する必要があります。
  1. {
  2. 'バージョン' : '1',
  3. 'event' : 'operator.作成',
  4. 'event_time' : $イベントの時間,
  5. 'org_id' : $soid,
  6. 'app_id' : $appid,
  7. 'attempt' : $もう一度試すの件数,
  8. 'entity_type' : $項目の種類,
  9. 'entity_id' : $ID,
  10. '項目' : {
  11. $項目 OBJECT
  12. },
  13. 'modified_fields' : [ ]
  14. }
例:
  1. {
  2. 'entity_type':'conversation',
  3. 'org_id':'14327896',
  4. 'event':'conversation。operator。replied',
  5. 'entity_id':'8000000004009',
  6. 'attempt':1,
  7. 'バージョン':'1',
  8. 'app_id':8000000000047,
  9. '項目':{
  10. 'id':'8000000004009',
  11. 'メッセージ':{
  12. 'sender':{
  13. '名前':'Tricia',
  14. 'id':'8000000000005'
  15. },
  16. 'msgid':'1566480708251',
  17. 'text':'こんにちは、配送ステータスについてヘルプが必要です'
  18. }
  19. },
  20. 'event_time':1566480708268,
  21. 'customer_info': {
  22. '支店': 'カリフォルニア',
  23. 'Band': 'プレミアム'
  24. }
  25. }

Webhook 利用前の前提条件

  1. https URL を利用することを推奨します（セキュリティ理由）。
  2. サーバーはポート番号付きのURLには接続できません。
  3. URLは、PostmanやTalend API Testerなど公開APIクライアントでアクセス可能である必要があります。サーバーからアクセス可能であることを確認してください。
  4. URLが指定されると、5秒の読み取りタイムアウトで検証のためにpingが送信されます。
  5. 5秒以内に到達できない場合、HTTP HEADリクエストでURLをチェックし、ステータスコード200の確認を行います。
  6. Webhookは10秒以内にレスポンスを返す必要があります。

Webhookが無効になるケース：

ケース1：WebhookがHTTPコード400以上を返し、完了確認のレスポンスを継続して返せない場合、ポータル担当者およびWebhook作成者にメールで警告が送信されます。
  1. Webhookが3時間連続で失敗した場合、最初の注意メールが送信され、6時間連続で失敗した場合には2回目の注意メールが送信されます。
  2. Webhookが12時間連続で失敗した場合、Webhookは無効化され、最終メールが送信されます。
ケース2：Webhookが登録された処理の投稿時にHTTPコード410を返した場合、SalesIQシステムはWebhookを削除し、ポータル担当者とWebhook作成者の両方にメールが送信されます。
Notes
メモ: この期間中にWebhookが完了レスポンスを返した場合は、通常通り動作します。ただし、再度失敗した場合は、上記の回数カウントが最初から再開されます。

処理

Webhookを利用すると、特定の処理がSalesIQ上で発生した際に通知を受け取ることができます。下記の処理リストにサブスクリプション登録している場合、各イベント発生時にデータとともに通知が届きます。

Webhookタブ

以下のタブが利用可能で、それぞれのタブに関連する操作が発生した際に通知を受け取ることができます。
  1. Conversation : Conversationでは、Webサイト訪問者とのやりとりを追跡・記録できます。会話には訪問者／オペレーターのメッセージ、関与したオペレーター、会話を担当する管理者／スーパーバイザー、その他の会話に関連する情報が含まれます。
  2. 部署 : 部署は管理イベントです。このイベントにサブスクリプション登録し、新規部署の作成・更新・削除時に通知を受け取ることができます。Webhook内の処理はデータ系と管理系の2種類があります。

Conversation

Conversationでは、Webサイト訪問者とのコミュニケーションを追跡・記録できます。会話には訪問者／オペレーターのメッセージ、関与したオペレーター、会話を担当する管理者／スーパーバイザー、その他の関連情報が含まれます。

Conversationに関する処理一覧:
  1. conversation.作成
  2. conversation。attender。updated
  3. conversation。missed
  4. conversation.完了
  5. conversation。rated
  6. conversation。visitor。replied
  7. conversation。operator。replied
  8. conversation.完了
  9. conversation。rated
  10. conversation。transfer.開始済み
  11. conversation。transfer.承認済み
  12. conversation。transfer.却下済み
  13. conversation.参加者.added
  14. conversation.参加者.削除
  15. conversation。supervisor。added
  16. conversation.メッセージ.編集
  17. conversation.メッセージ.削除
  18. conversation。metrics

conversation.作成

このイベントにサブスクリプション登録することで、訪問者がチャットを開始した際に通知を受け取ることができます。

  2. データの内容:
  3. {
  4. 'id': '17000000004021',
  5. 'visitor_conversation_id': 'ad433hjdid546f8n4b734j4omfhjsrwnet46fklf7',
  6. 'reference_id': '1',
  7. 'opened_time': '1556866331533',
  8. 'attended_time': '1556866331553',
  9. 'end_time': '1556866331929',
  10. 'missed_time': '1556866333232',
  11. 'app_id': '30185567778889',
  12. 'department_id': '301050000004',
  13. '担当者': {
  14. 'id': '30102333033335',
  15. '名前': 'Patricia',
  16. 'email_id': 'patricia@zylker。com'
  17. },
  18. 'visitor':{
  19. 'email_id':'tricia@zylker。com',
  20. '電話番号':'1234354',
  21. '名前':'Tricia',
  22. '種類' : '連絡先',
  23. 'id': '30000000090034'
  24. },
  25. 'question': 'こんにちは、ダイニングセットの購入についてサポートが必要です。',
  26. 'supervisors': [
  27. '30102333033336',
  28. '30102333033337'
  29. ],
  30. '参加者': [
  31. '30102333033336',
  32. '30102333033337'
  33. ],
  34. 'ステータス': '有効',
  35. 'chat_status': {
  36. 'status_code': [
  37. '1,2'
  38. ],
  39. '状態': [
  40. '1,2,3,4'
  41. ],
  42. 'ラベル': '有効'
  43. },
  44. 'customer_info': {
  45. '支店': 'California',
  46. 'Band': 'プレミアム'
  47. }
  48. }

conversation.attender.updated

オペレーターがチャットを受け取った際に通知を受けるために、サブスクリプション管理でこのイベントを購読できます。

  2. データの内容:

  4. {
  5. 'id': '17000000004021',
  6. 'visitor_conversation_id': 'ad433hjdid546f8n4b734j4omfhjsrwnet46fklf7',
  7. 'reference_id': '1',
  8. 'opened_time': '1556866331533',
  9. 'attended_time': '1556866331553',
  10. 'end_time': '1556866331929',
  11. 'missed_time': '1556866333232',
  12. 'app_id': '30185567778889',
  13. 'department_id': '301050000004',
  14. '担当者': {
  15. 'id': '30102333033335',
  16. '名前': 'Patricia',
  17. 'email_id': 'patricia@zylker。com'
  18. },
  19. 'visitor':{
  20. 'email_id':'tricia@zylker。com',
  21. '電話番号':'124534354',
  22. '名前':'Tricia',
  23. '種類' : '連絡先',
  24. 'id': '30000000090034'
  25. }
  26. },
  27. 'question': 'こんにちは、ダイニングセットの購入についてサポートが必要です。',
  28. 'supervisors': [
  29. '30102333033336',
  30. '30102333033337'
  31. ],
  32. '参加者': [
  33. '30102333033336',
  34. '30102333033337'
  35. ],
  36. 'ステータス': '接続済み',
  37. 'chat_status': {
  38. 'status_code': [
  39. '1,2'
  40. ],
  41. '状態': [
  42. '1,2,3,4'
  43. ],
  44. 'ラベル': 'Attended オンライン'
  45. },
  46. 'customer_info': {
  47. '支店': 'California',
  48. 'Band': 'プレミアム'
  49. }
  50. }

conversation。missed

サブスクリプション管理でこのイベントに登録すると、訪問者によって開始されたチャットが、いずれのオペレーターにも対応されず未対応となった場合に通知を受け取ることができます。

  2. データの内容:
  3. {
  4. 'id': '17000000004021',
  5. 'visitor_conversation_id': 'ad433hjdid546f8n4b734j4omfhjsrwnet46fklf7',
  6. 'reference_id': '1',
  7. 'opened_time': '1556866331533',
  8. 'attended_time': '1556866331553',
  9. 'end_time': '1556866331929',
  10. 'missed_time': '1556866333232',
  11. 'app_id': '30185567778889',
  12. 'department_id': '301050000004',
  13. '担当者': {
  14. 'id': '30102333033335',
  15. '名前': 'Patricia',
  16. 'email_id': 'patricia@zylker。com'
  17. },
  18. 'visitor':{
  19. 'email_id':'tricia@zylker。com',
  20. '電話番号':'12344354',
  21. '名前':'Tricia',
  22. '種類' : '連絡先',
  23. 'id': '30000000090034'
  24. },
  25. 'question': 'こんにちは、ダイニングセットの購入についてサポートが必要です。',
  26. 'supervisors': [
  27. '30102333033336',
  28. '30102333033337'
  29. ],
  30. '参加者': [
  31. '30102333033336',
  32. '30102333033337'
  33. ],
  34. 'ステータス': 'Missed',
  35. 'chat_status': {
  36. 'status_code': [
  37. '1,2'
  38. ],
  39. '状態': [
  40. '1,2,3,4'
  41. ],
  42. 'ラベル': 'CRMで追跡'
  43. },
  44. 'customer_info': {
  45. '支店': 'カリフォルニア',
  46. 'Band': 'プレミアム'
  47. }
  48. }

conversation。operator。replied

このイベントで、オペレーターが訪問者によって開始されたチャットに返信した際に通知を受け取りたい場合は、サブスクリプション管理で設定できます。

  2. データの内容:

  4. {
  5. 'id':'8000000004009',
  6. 'メッセージ':{
  7. 'sender':{
  8. '名前':'Tricia',
  9. 'id':'8000000000005'
  10. },
  11. 'msgid':'1566480708251',
  12. 'text':'ダイニングセットの購入についてサポートが必要です。'
  13. },
  14. 'visitor':{
  15. 'email_id':'tricia@zylker。com',
  16. '電話番号':'12344354',
  17. '名前':'Tricia',
  18. '種類' : '連絡先',
  19. 'id': '30000000090034'
  20. },
  21. '担当者':{
  22. 'id':'30102333033335',
  23. '名前':'Patricia',
  24. 'email_id':'patricia@zylker。com'
  25. },
  26. 'バージョン':1
  27. }

  29. Bot Conversation データの内容:

  31. {
  32. メッセージ : {
  33. 'sender' : {
  34. 'id' : $sender wms id,
  35. '名前' : $sender 名前
  36. },
  37. 'text' : $msg, // bot メッセージには含まれません
  38. 'msgid' : $msg id, // bot メッセージには含まれません
  39. 'meta' : $meta data, ---> bot メッセージに適用されます
  40. 'list' : [
  41. $メッセージ LIST
  42. ]
  43. },
  44. 'customer_info': {
  45. '支店': 'カリフォルニア',
  46. 'Band': 'プレミアム'
  47. }
  48. }

conversation.visitor.replied

訪問者が返信した際に通知を受け取りたい場合は、このイベントにサブスクリプション管理が可能です。

  2. データの内容:

  4. {
  5. 'id': '8000000005001',
  6. 'メッセージ': {
  7. 'sender': {
  8. '名前': 'Tricia',
  9. 'id': '$2463902591169630574'
  10. },
  11. 'msgid': '1566481170562',
  12. 'text': 'こんにちは、ダイニングセットの購入に関してサポートが必要です'
  13. },
  14. '担当者': {
  15. 'id': '30102333033335',
  16. '名前': 'Patricia',
  17. 'email_id': 'patricia@zylker。com'
  18. },
  19. 'visitor':{
  20. 'email_id':'tricia@zylker。com',
  21. '電話番号':'1234354',
  22. '名前':'Tricia',
  23. '種類' : '連絡先',
  24. 'id': '30000000090034'
  25. },
  26. 'バージョン': 1
  27. },
  28. 'customer_info': {
  29. '支店': 'California',
  30. 'Band': 'プレミアム'
  31. }

conversation.完了

チャット会話が終了した際に通知を受け取りたい場合は、このイベントにサブスクリプション管理を追加できます。

  2. データの内容:
  3. {
  4. 'id': '17000000004021',
  5. 'visitor_conversation_id': 'ad433hjdid546f8n4b734j4omfhjsrwnet46fklf7',
  6. 'reference_id': '1',
  7. 'opened_time': '1556866331533',
  8. 'attended_time': '1556866331553',
  9. 'end_time': '1556866331929',
  10. 'missed_time': '1556866333232',
  11. 'app_id': '30185567778889',
  12. 'department_id': '301050000004',
  13. '担当者': {
  14. 'id': '30102333033335',
  15. '名前': 'Patricia',
  16. 'email_id': 'patricia@zylker。com'
  17. },
  18. 'visitor':{
  19. 'email_id':'tricia@zylker。com',
  20. '電話番号':'12344354',
  21. '名前':'Tricia',
  22. '種類' : '連絡先',
  23. 'id': '30000000090034'
  24. },
  25. 'question': 'こんにちは、ダイニングセットの購入についてサポートが必要です。',
  26. 'supervisors': [
  27. '30102333033336',
  28. '30102333033337'
  29. ],
  30. '参加者': [
  31. '30102333033336',
  32. '30102333033337'
  33. ],
  34. 'ステータス': '完了済み',
  35. 'chat_status': {
  36. 'status_code': [
  37. '1,2'
  38. ],
  39. '状態': [
  40. '1,2,3,4'
  41. ],
  42. 'ラベル': 'メールによる対応'
  43. },
  44. 'customer_info': {
  45. '支店': 'カリフォルニア',
  46. 'Band': 'プレミアム'
  47. }
  48. }

conversation.rated

サブスクリプション管理でこのイベントに登録することで、訪問者がオペレーターとのチャットの評価やフィードバックを行った際に通知を受け取ることができます。

  2. 評価用データ内容:
  3. {
  4. '評価': 4,
  5. 'フィードバック': 'Good サポート',
  6. '担当者': {
  7. 'id': '30102333033335',
  8. '名前': 'Patricia',
  9. 'email_id': 'patricia@zylker。com'
  10. },
  11. 'visitor':{
  12. 'email_id':'tricia@zylker。com',
  13. '電話番号':'12344354',
  14. '名前':'Tricia',
  15. '種類' : '連絡先',
  16. 'id': '30000000090034'
  17. },
  18. 'customer_info': {
  19. '支店': 'California',
  20. 'Band': 'プレミアム'
  21. }
  22. }

  24. フィードバック用データ内容:

  26. {
  27. 'entity_type': 'conversation',
  28. 'org_id': '55778119',
  29. 'event': 'conversation。rated',
  30. 'entity_id': '40526000001808033',
  31. 'attempt': 1,
  32. 'バージョン': '1',
  33. 'app_id': 40526000000002040,
  34. '項目': {
  35. '担当者': {
  36. '名前': 'Patricia',
  37. 'email_id': 'patricia@zylker。com'
  38. 'id': '40526000000002001'
  39. },
  40. 'フィードバック': 'Awesome サポート 差出人 the reps!',
  41. 'id': '40526000001808033',
  42. 'ステータス': 'Ended',
  43. 'visitor':{
  44. 'email_id':'tricia@zylker。com',
  45. '電話番号':'12344354',
  46. '名前':'Tricia',
  47. '種類' : '連絡先',
  48. 'id': '30000000090034'
  49. }
  50. },
  51. 'event_time': '1567065865617',
  52. 'customer_info': {
  53. '支店': 'California',
  54. 'Band': 'プレミアム'
  55. }
  56. }

conversation。transfer.開始済み

このイベントで会話転送が開始された際に通知を受けたい場合は、サブスクリプション管理を設定できます。

データの内容:
  1. {
  2. '担当者': {
  3. 'email_id': 'patricia@zylker。com',
  4. '名前': 'patricia@zylker。com',
  5. 'id': '30000000099007'
  6. },
  7. 'transfer': {
  8. 'メモ': '詳細 必須',
  9. '種類': 'ユーザー|部署',
  10. 'department_id': '30000000148001',
  11. 'transferred_by': {
  12. '種類': 'bot|operator',
  13. 'email_id': 'patricia@zylker。com',
  14. '名前': 'patricia@zylker。com',
  15. 'id': '30000000099007'
  16. },
  17. 'transferred_to': [
  18. {
  19. 'id': '30000000000006',
  20. '名前': 'Patricia',
  21. 'email_id': 'patricia@zylker。com'
  22. }
  23. ]
  24. },
  25. 'waiting_time': '60',
  26. 'question': 'こんにちは、ダイニングセットの購入についてサポートが必要です',
  27. 'department_id': '30000000000018',
  28. 'id': '30000000095001',
  29. 'visitor_conversation_id': '2d665c42a02e919ac0f91f62fa78581d',
  30. 'visitor': {
  31. 'email_id': 'tricia@zylker。com',
  32. '電話番号': '1234354',
  33. '名前': 'Tricia',
  34. '種類': '連絡先',
  35. 'id': '30000000090034'
  36. }

conversation。transfer.承認済み

オペレーターによってチャットの移動が承認された際に通知を受け取りたい場合、このイベントにサブスクリプション管理を設定できます。

データの内容:
  1. {
  2. 'accepted_by': {
  3. '名前': 'Patricia',
  4. 'id': '30000000000006',
  5. 'email_id': 'patricia@zylker。com'
  6. },
  7. 'question': 'ダイニングセットの購入についてサポートが必要です。',
  8. 'department_id': '30000000000018',
  9. 'id': '30000000158001',
  10. 'visitor': {
  11. 'email_id': 'tricia@zylker。com',
  12. '電話番号': '1234354',
  13. '名前': 'Tricia',
  14. '種類': '連絡先',
  15. 'id': '30000000090034'
  16. },
  17. 'visitor_conversation_id': '2d665c42a02e919a171b7845509162e6'
  18. }

conversation。transfer.却下済み

オペレーターによって移動済みチャットが却下された際に通知を受け取りたい場合は、このイベントにサブスクリプション管理を行えます。

データの内容:
  1. {
  2. 'rejected_by': {
  3. '種類': 'auto | manual',
  4. '名前': 'Patricia',
  5. 'id': '30000000000006',
  6. 'email_id': 'patricia@zylker。com'
  7. },
  8. 'question': 'こんにちは、ダイニングセットの購入についてサポートが必要です',
  9. 'department_id': '30000000000018',
  10. 'id': '30000000158001',
  11. 'visitor': {
  12. 'email_id': 'tricia@zylker。com',
  13. '電話番号': '1234354',
  14. '名前': 'Tricia',
  15. '種類': '連絡先',
  16. 'id': '30000000090034'
  17. },
  18. 'visitor_conversation_id': '2d665c42a02e919ac0f91f62fa78581d'
  19. }

conversation.参加者.added

チャットに参加者が招待された際に通知を受け取りたい場合は、このイベントにサブスクリプション管理を行えます。

データの内容:
  1. {
  2. 'question': 'こんにちは、ダイニングセットの購入についてサポートが必要です',
  3. 'department_id': '30000000000018',
  4. 'id': '30000000095001',
  5. 'invite': {
  6. 'メモ': 'asdfqsf',
  7. 'added_by': {
  8. '名前': 'patricia@zylker。com',
  9. 'id': '30000000099007',
  10. 'email_id': 'patricia@zylker。com'
  11. },
  12. 'added_operators': [
  13. {
  14. '名前': 'Patricia',
  15. 'id': '30000000000006',
  16. 'email_id': 'patricia@zylker。com'
  17. }
  18. ]
  19. },
  20. 'visitor_conversation_id': '2d665c42a02e919ac0f91f62fa78581d',
  21. 'visitor': {
  22. 'email_id': 'tricia@zylker。com',
  23. '電話番号': '1234354',
  24. '名前': 'Tricia',
  25. '種類': '連絡先',
  26. 'id': '30000000090034'
  27. },
  28. '担当者': {
  29. '名前': 'Patricia',
  30. 'id': '30000000000006',
  31. 'email_id': 'patricia@zylker。com'
  32. }
  33. }

conversation.参加者.削除

このイベントの通知を受け取る場合は、サブスクリプション管理にて設定できます。会話から参加者が削除されると通知されます。
​
データ内容：
  1. {
  2. 'question': 'こんにちは、ダイニングセットの購入についてサポートが必要です',
  3. 'department_id': '30000000000018',
  4. 'deleted_by': {
  5. '名前': 'Patricia',
  6. 'id': '30000000000006',
  7. 'email_id': 'patricia@zylker。com'
  8. },
  9. 'deleted_operators': [
  10. {
  11. '名前': 'Patricia+1',
  12. 'id': '30000000000106',
  13. 'email_id': 'patricia@zylker。com'
  14. }
  15. ],
  16. 'visitor': {
  17. 'email_id': 'tricia@zylker。com',
  18. '電話番号': '1234354',
  19. '名前': 'Tricia',
  20. '種類': '連絡先',
  21. 'id': '30000000090034'
  22. },
  23. '担当者': {
  24. '名前': 'Patricia',
  25. 'id': '30000000000006',
  26. 'email_id': 'patricia@zylker。com'
  27. },
  28. 'id': '30000000095001',
  29. 'visitor_conversation_id': '2d665c42a02e919ac0f91f62fa78581d'
  30. }

conversation。supervisor。added

このイベントにサブスクリプション管理を行うことで、スーパーバイザーがチャットに追加された際に通知を受け取ることができます。
​
データの内容:
  1. {
  2. 'added_operators': [
  3. {
  4. '名前': 'Patricia',
  5. 'id': '30000000000006',
  6. 'email_id': 'patricia@zylker。com'
  7. }
  8. ],
  9. 'id': '30000000095001',
  10. 'question': 'こんにちは、ダイニングセットの購入についてサポートが必要です',
  11. 'department_id': '30000000000018',
  12. 'visitor': {
  13. 'email_id': 'tricia@zylker。com',
  14. '電話番号': '1234354',
  15. '名前': 'Tricia',
  16. '種類': '連絡先',
  17. 'id': '30000000090034'
  18. },
  19. '担当者': {
  20. '名前': 'Patricia+1',
  21. 'id': '30000000000106',
  22. 'email_id': 'patricia@zylker。com'
  23. },
  24. 'visitor_conversation_id': '2d665c42a02e919ac0f91f62fa78581d'
  25. }

conversation.メッセージ.編集

チャット内でメッセージが編集された際に通知を受け取りたい場合、このイベントにサブスクリプション管理を行ってください。

データの内容:
  1. {
  2. 'id': '8000000005001',
  3. 'メッセージ': {
  4. 'sender': {
  5. '名前': 'Patricia',
  6. 'id': '30000000000006'
  7. },
  8. 'msgid': '1566481170562',
  9. 'text': 'abcc'
  10. },
  11. 'visitor': {
  12. 'email_id': 'tricia@zylker。com',
  13. '電話番号': '1234354',
  14. '名前': 'Tricia',
  15. '種類': '連絡先',
  16. 'id': '30000000090034'
  17. },
  18. '担当者': {
  19. '名前': 'Patricia+1',
  20. 'id': '30000000000106',
  21. 'email_id': 'patricia@zylker。com'
  22. },
  23. 'visitor_conversation_id': '2d665c42a02e919ac0f91f62fa78581d'
  24. }

conversation.メッセージ.削除

チャットでメッセージが削除された際に通知を受け取りたい場合は、このイベントにサブスクリプション管理を設定できます。

データの内容:
  1. {
  2. 'id': '8000000005001',
  3. 'メッセージ': {
  4. 'sender': {
  5. '名前': 'Patricia',
  6. 'id': '30000000000006'
  7. },
  8. 'msgid': '1566481170562'
  9. },
  10. 'visitor': {
  11. 'email_id': 'tricia@zylker。com',
  12. '電話番号': '1234354',
  13. '名前': 'Tricia',
  14. '種類': '連絡先',
  15. 'id': '30000000090034'
  16. },
  17. '担当者': {
  18. '名前': 'Patricia+1',
  19. 'id': '30000000000106',
  20. 'email_id': 'patricia@zylker。com'
  21. },
  22. 'visitor_conversation_id': '2d665c42a02e919ac0f91f62fa78581d',
  23. }

conversation.metrics

サブスクリプション管理でこのイベントに登録すると、会話が終了した際に、その会話のメトリクスとメタデータを含む通知を受け取ることができます。

データの内容：
  1. {
  2. 'entity_type': 'conversation',
  3. 'org_id': '65423290',
  4. 'event': 'conversation。metrics',
  5. 'entity_id': '115844000014120021',
  6. 'attempt': 1,
  7. 'バージョン': '1',
  8. 'app_id': '115844000002965011',
  9. '項目': {
  10. 'inititated_by': '訪問者',
  11. 'question': '12',
  12. 'end_time': '1721653023236',
  13. 'chat_id': '29115',
  14. 'connected_time': '1721653003085',
  15. 'opened_time': '1721652997651',
  16. 'ended_by': 'オペレーター',
  17. 'id': '115844000014120021',
  18. 'metrics': {
  19. 'operator_message_count': '2',
  20. 'visitor_message_count': '3',
  21. 'bot_message_count':'2',
  22. 'info_message_count':'4',
  23. 'system_event_count':'1',
  24. 'average_response_time': '5792',
  25. 'first_response_time': '6105',
  26. 'total_chat_duration': '20151',
  27. 'visitor_waiting_time': '5434',
  28. 'missed_reason':'すべてのオペレーターが対応中です。',
  29. 'bot_pickup_after':'1721652997651',
  30. 'bot_duration':'172165299764',
  31. 'queued_duration':'1721652997751',
  32. 'first_agent_accept_after':'1721652999651',
  33. 'total_operator_duration':'1721652997651',
  34.             
  35. },
  36. '時間': {
  37. 'initiated_time':'1721652997651',
  38. 'connected_time':'1721652997655',
  39. 'bot_pickup_time':'1721652997655',

    40. 部署

    Webhook には「データ」と「管理」の2種類の処理があります。部署は管理イベントに該当します。このイベントにサブスクリプション管理を設定すると、新規部署が作成、更新、または削除された際に通知を受け取ることができます。

    部署処理の一覧：
    1. 部署.作成
    2. 部署.削除
    3. 部署.updated

    部署.作成

    このイベントにサブスクリプション管理を設定することで、ポータル内で新規部署が作成されるたびに通知を受け取ることができます。

    2. データの内容:

    4. {
    5. 'entity_type': '部署',
    6. 'org_id': '55778119',
    7. 'event': '部署.作成',
    8. 'entity_id': '40526000001808025',
    9. 'attempt': 1,
    10. 'バージョン': '1',
    11. '項目': {
    12. 'is_enabled': '真',
    13. 'created_time': '1571032858870',
    14. 'modified_time': '1571032858870',
    15. 'operators': [
    16. '6000000000005'
    17. ],
    18. 'is_system_generated': '無効',
    19. '名前': 'サポート',
    20. 'is_public': '真',
    21. 'email_configurations': {
    22. 'missedchat_recipients': '',
    23. 'cc_recipients': '',
    24. 'is_blockip_mail_enabled': '真',
    25. 'from_email': 'tricia@zylker。com',
    26. 'transcript_recipients': 'tricia@zylker。com',
    27. 'is_feedback_mail_enabled': '真',
    28. 'blockip_recipients': '',
    29. 'feedback_recipients': '',
    30. 'is_missedchat_mail_enabled': '真',
    31. 'is_cc_mail_enabled': '真',
    32. 'is_transcript_mail_enabled': '真'
    33. },
    34. '説明': 'サイト上の訪問者をサポートするチーム',
    35. 'id': '6000000009015',
    36. 'display_name': 'Zylker-サポート',
    37. 'created_by': '6000000000005'
    38. },
    39. 'event_time': '1567065647511',
    40. 'customer_info': {
    41. '支店': 'California',
    42. 'Band': 'プレミアム'
    43. }
    44. }

    部署.削除

    サブスクリプション管理でこのイベントを追加すると、ポータル内で部署が削除された際に通知を受け取ることができます。

    2. データの内容:

    4. {
    5. 'entity_type': '部署',
    6. 'org_id': '55778119',
    7. 'event': '部署.削除',
    8. 'entity_id': '40526000001808025',
    9. 'attempt': 1,
    10. 'バージョン': '1',
    11. 'event_time': '1567065647511',
    12. 'customer_info': {
    13. '支店': 'California',
    14. 'Band': 'プレミアム'
    15. }
    16. }

    部署.updated

    このイベントにサブスクリプション管理を行うことで、部署の詳細が更新された際に通知を受け取ることができます。
    1. データの内容:
    2. {
    3. 'entity_type': '部署',
    4. 'org_id': '55778119',
    5. 'event': '部署.updated',
    6. 'entity_id': '40526000001808025',
    7. 'attempt': 1,
    8. 'バージョン': '1',
    9. '項目': {
    10. 'is_enabled': '真',
    11. 'created_time': '1571032858870',
    12. 'modified_time': '1571032858870',
    13. 'operators': [
    14. '6000000000005'
    15. ],
    16. 'is_system_generated': '無効',
    17. '名前': 'サポート',
    18. 'is_public': '真',
    19. 'email_configurations': {
    20. 'missedchat_recipients': '',
    21. 'cc_recipients': '',
    22. 'is_blockip_mail_enabled': '真',
    23. 'from_email': 'tricia@zylker。com',
    24. 'transcript_recipients': 'tricia@zylker。com',
    25. 'is_feedback_mail_enabled': '真',
    26. 'blockip_recipients': '',
    27. 'feedback_recipients': '',
    28. 'is_missedchat_mail_enabled': '真',
    29. 'is_cc_mail_enabled': '真',
    30. 'is_transcript_mail_enabled': '真'
    31. },
    32. '説明': 'サイト上の訪問者をサポートするチーム',
    33. 'id': '6000000009015',
    34. 'display_name': 'Zylker-サポート',
    35. 'created_by': '6000000000005'
    36. },
    37. 'event_time': '1567065647511',
    38. 'customer_info': {
    39. '支店': 'California',
    40. 'Band': 'プレミアム'
    41. }
    42. }

    オペレーター

    Webhookには、データ処理と管理処理の2種類があります。オペレーターは管理イベントであり、オペレーターイベントが実行された際に通知を受けるためにサブスクリプション管理を行うことができます。

    オペレーター処理一覧:
    1. operator.作成
    2. operator。updated
    3. operator.削除
    4. operator.部署.関連付け済み
    5. operator.部署.dissociated

    operator.作成

    このイベントにサブスクリプション管理を設定すると、組織に新しいオペレーターが追加されるたびに通知を受け取ることができます。

    データの内容:
    1. {
    2. 'entity_type': 'operator',
    3. 'org_id': '15188410',
    4. 'event': 'operator.作成',
    5. 'entity_id': '115000000029087',
    6. 'attempt': 1,
    7. 'バージョン': '1',
    8. '項目': {
    9. 'email_id': 'patricia@zylker。com',
    10. 'access_levels': [
    11. 'chat',
    12. 'tracking'
    13. ],
    14. '役割': 'Administrator',
    15. '署名': '2e8132839ffef039e24ab8e162b5b1f1',
    16. 'date_of_birth': '',
    17. '説明': '',
    18. '言語': '',
    19. 'chat_enabled': 真,
    20. '種類': 'Salesiq ユーザー',
    21. 'locale': '',
    22. 'confirmed': 無効,
    23. '有効': 真,
    24. '通知': {
    25. 'return_visit': 無効,
    26. 'new_visit': 無効
    27. },
    28. 'modified_time': '1596093400214',
    29. 'id': '115000000029087',
    30. '部署': [
    31. '115000000004001',
    32. '115000000000018'
    33. ],
    34. 'first_name': '',
    35. '担当者': 無効,
    36. 'created_time': '1596093400198',
    37. 'time_format': '12 時間',
    38. '住所': {
    39. '国': '',
    40. 'pincode': '',
    41. '市区町村': '',
    42. '町名・番地': '',
    43. '状態': ''
    44. },
    45. 'maximum_concurrent_chat': 'なし',
    46. 'image_url': '',
    47. 'モバイル': '',
    48. 'last_name': '',
    49. 'time_zone': '',
    50. 'locale_country': '',
    51. '削除': 無効,
    52. '電話番号': '',
    53. 'nick_name': 'Patricia',
    54. 'social_media': {
    55. 'Twitter': {
    56. 'profile_url': ''
    57. },
    58. 'linkedin': {
    59. 'profile_url': ''
    60. },
    61. '有効': 無効
    62. },
    63. 'ステータス': '利用可能'
    64. },
    65. 'event_time': '1596093402483',
    66. 'customer_info': {
    67. '支店': 'California',
    68. 'Band': 'プレミアム'
    69. }
    70. }

    operator。updated

    サブスクリプション管理で、オペレーターの設定が更新された時に通知を受け取りたい場合は、このイベントを利用できます。

    データの内容:
    1. {
    2. 'entity_type': 'operator',
    3. 'org_id': '15188410',
    4. 'event': 'operator。updated',
    5. 'entity_id': '115000000000094',
    6. 'attempt': 1,
    7. 'バージョン': '1',
    8. '項目': {
    9. 'email_id': 'patricia@zylker。com',
    10. 'access_levels': [
    11. 'chat',
    12. 'トラッキング'
    13. ],
    14. '役割': 'Administrator',
    15. '署名': '2e8132839ffef039e7eaaa00748b47ec',
    16. '生年月日': '',
    17. '説明': '',
    18. '言語': 'en',
    19. 'チャット有効': 真,
    20. '種類': 'Salesiq ユーザー',
    21. 'ロケール': 'en',
    22. '確認済み': 真,
    23. '有効': 真,
    24. '通知': {
    25. '再訪問': 無効,
    26. '新規訪問': 無効
    27. },
    28. '更新日時': '1596092957234',
    29. 'ID': '115000000000094',
    30. '部署': [
    31. '115000000000018'
    32. ],
    33. '名': 'Patricia',
    34. '担当者': 無効,
    35. '作成日時': '1594720783132',
    36. '時間形式': '12時間',
    37. '住所': {
    38. '国': 'us',
    39. '郵便番号': '625012',
    40. '市区町村': 'Malibu',
    41. '町名・番地': 'Pacific Coast Highway',
    42. '州': 'California'
    43. },
    44. '同時チャット最大数': 'なし',
    45. '画像URL': '',
    46. 'モバイル': '08903694722',
    47. 'last_name': 'Smith',
    48. 'time_zone': 'United 都道府県/California',
    49. 'zuid': '15102744',
    50. 'locale_country': 'us',
    51. '削除': 無効,
    52. '電話番号': '1234567890',
    53. 'nick_name': 'Patricia',
    54. 'social_media': {
    55. 'Twitter': {
    56. 'profile_url': ''
    57. },
    58. 'linkedin': {
    59. 'profile_url': ''
    60. },
    61. '有効': 無効
    62. },
    63. 'ステータス': '利用可能'
    64. },
    65. 'event_time': '1596092957257',
    66. 'customer_info': {
    67. '支店': 'California',
    68. 'Band': 'プレミアム'
    69. }
    70. }

    operator.削除

    オペレーターが削除された際に通知を受け取りたい場合は、このイベントにサブスクリプション管理を設定できます。

    データの内容：
    1. {
    2. 'entity_type': 'operator',
    3. 'org_id': '15188410',
    4. 'entity_id': '115000000029087',
    5. 'event': 'operator.削除',
    6. 'バージョン': '1',
    7. 'attempt': 1,
    8. 'event_time': '1596093526367',
    9. 'customer_info': {
    10. '支店': 'California',
    11. 'Band': 'プレミアム'
    12. }

    14. }

    operator.部署.関連付け済み

    サブスクリプション管理でこのイベントに登録すると、オペレーターが部署に関連付けられるたびに通知を受け取ることができます。
    データの内容:
    1. {
    2. 'entity_type': 'operator',
    3. 'org_id': '15188410',
    4. 'event': 'operator.部署.関連付け済み',
    5. 'entity_id': '115000000000006',
    6. 'attempt': 1,
    7. 'バージョン': '1',
    8. '項目': {
    9. '部署': [
    10. '115000000004001'
    11. ],
    12. 'id': '115000000000006'
    13. },
    14. 'event_time': '1596094781678',
    15. 'customer_info': {
    16. '支店': 'California',
    17. 'Band': 'プレミアム'
    18. }
    19. }

    operator.部署.dissociated

    オペレーターが部署から削除された際に通知を受け取りたい場合、このイベントにサブスクリプション管理を設定できます。
    データの内容:
    1. {
    2. 'entity_type': 'operator',
    3. 'org_id': '15188410',
    4. 'event': 'operator.部署.dissociated',
    5. 'entity_id': '115000000000006',
    6. 'attempt': 1,
    7. 'バージョン': '1',
    8. '項目': {
    9. '部署': [
    10. '115000000004001'
    11. ],
    12. 'id': '115000000000006'
    13. },
    14. 'event_time': '1596094781678',
    15. 'customer_info': {
    16. '支店': 'California',
    17. 'Band': 'プレミアム'
    18. }
    19. }

    訪問者

    Webhook には2種類の処理タイプ（データと管理）があります。訪問者はデータイベントに該当します。訪問者イベントが発生した際に通知を受け取るには、サブスクリプション管理から設定できます。

    訪問者処理の一覧：
    1. visitor。updated

    visitor。updated

    このイベントにサブスクリプション登録することで、訪問者情報が更新された際に通知を受け取ることができます。

    ケース1: リード情報が更新されると、このデータの内容を受け取ります。

    データの内容:
    1. {
    2. 'id': '30000000095001',
    3. '種類': 'lead ',
    4. 'first_name': 'Scott',
    5. 'last_name': 'Smith',
    6. 'modifier': {
    7. '種類': 'operator',
    8. 'email_id': 'patricia@zylker。com',
    9. '名前': 'patricia@zylker。com',
    10. 'id': '30000000099007'
    11. },
    12. 'customer_info': {
    13. '支店': 'California',
    14. 'Band': 'プレミアム'
    15. }
    16. }
    ケース2：リードに連絡先情報が追加された際に、このデータの内容を受け取ります。

    Notes
    メモ: メールや電話番号などの情報が初めて提供された場合、リードは連絡先へ変換されます。

    データの内容:
    1. {
    2. 'id': '30000000095001',
    3. '種類': '連絡先',
    4. 'first_name': 'Scott',
    5. 'last_name': 'Smith',
    6. 'email_id': 'scottsmith@zylker。com',
    7. '電話番号': '9123459876',
    8. 'lead': {
    9. 'id': '30000000090034'
    10. },
    11. 'modifier': {
    12. '種類': 'operator',
    13. 'email_id': 'patricia@zylker。com',
    14. '名前': 'patricia@zylker。com',
    15. 'id': '30000000099007'
    16. },
    17. 'customer_info': {
    18. '支店': 'California',
    19. 'Band': 'プレミアム'
    20. }
    21. }
    ケース 3: 連絡先の情報が更新されると、このデータの内容を受領します。

    データの内容:
    1. {
    2. 'id': '30000000095001',
    3. '種類': '連絡先',
    4. 'first_name': 'Scott',
    5. 'last_name': 'Smith',
    6. 'email_id': 'scottsmith@zylker。com',
    7. '電話番号': '91234598121',
    8. 'modifier': {
    9. '種類': 'operator',
    10. 'email_id': 'patricia@zylker。com',
    11. '名前': 'patricia@zylker。com',
    12. 'id': '30000000099007'
    13. },
    14. 'customer_info': {
    15. '支店': 'California',
    16. 'Band': 'プレミアム'
    17. }
    18. }

    Webhook を設定する

    Webhook を設定するには、
    1. SalesIQ ダッシュボード内で、設定 > Developers > Webhook に移動します。
    2. ここでは、管理タブとデータタブでポータルベースおよび埋め込みベースの処理をそれぞれ Webhook 経由で追加できます。イベント発生時には指定した URL へ通知されます。


    管理タブでポータルベースの Webhook を追加する方法

    管理タブ内で、ポータルの操作に基づいた Webhook を作成できます。サブスクリプションに応じて、ポータルイベント発生時に通知を受け取ることができます。新しい Webhook を追加するには、
    1. 追加 をクリックします。
    2. 呼び出す必要のある URL を入力します。
    3. Webhook に関連付けたい処理を選択します。

    1. 最後に、Webhook を作成 をクリックすると、Webhook が作成されます。
    2. ここで Webhook の手順も確認できます。


    AdministrationタブでポータルベースのWebhookを削除する方法
    Webhookを削除するには、
    1. ダッシュボードで削除したいWebhookにカーソルを合わせ、右端に表示される削除アイコンをクリックします。

    1. 確認のポップアップが表示されます。削除をクリックするとWebhookが削除されます。

    AdministrationタブでWebhookを有効化／無効化する方法
    Webhookを有効化または無効化するには、
    1. 各Webhookの右端に表示されるトグルボタンをクリックします。
    DataタブでembedベースのWebhookを追加する方法
    Dataタブ内で、embed操作に基づいたWebhookを作成できます。サブスクリプション後、embedイベントが発生するたびに通知されます。新規Webhookを追加するには、
    1. 追加するをクリックします。
    2. Webhookを作成したいSalesIQアプリを選択します。

    1. 呼び出すURLを入力します。
    2. Webhookに関連付ける処理を選択します。

    1. 最後に、作成 WebhookをクリックするとWebhookが作成されます。
    2. Webhookの手順もここで確認できます。



    DataタブでembedベースのWebhookを削除する方法

    Webhookを削除するには、
    1. ダッシュボードで削除したいWebhookにカーソルを合わせ、右端に表示される削除アイコンをクリックします。

    1. 確認のポップアップが表示されます。削除をクリックすると、Webhookが削除されます。


    DataタブでWebhookを有効にする／無効にする方法
    Webhookを有効にする／無効にするには、
    1. 各Webhookの右端に表示されるトグルボタンをクリックします。

    ダッシュボード:

    Webhookダッシュボードでは、以下の詳細を表示できます：
    1. 失敗: Webhookが失敗した回数
    2. Last 実行済み: Webhookが最後に実行された日時
    3. App: Webhookが関連付けられているアプリの一覧



    Zoho CRM 管理者向けトレーニング

    「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。

    日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。

    Zoho CRM Training



              Zoho Campaigns Resources

                Zoho WorkDrive Resources




                  • Desk Community Learning Series


                  • Digest


                  • Functions


                  • Meetups


                  • Kbase


                  • Resources


                  • Glossary


                  • Desk Marketplace


                  • MVP Corner


                  • Word of the Day


                  • Ask the Experts






                          Latest Feature Updates



                                  Resources

                                  Videos

                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                  eBooks

                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                  Webinars

                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                  CRM Tips

                                  Make the most of Zoho CRM with these useful tips.