Webhook

Webhook

Webhookとは

Webhookは、アプリケーション同士を連携させるための仕組みの1つです。Webhookを活用すると、あるアプリケーションで何らかの処理が発生したときに、連携先のアプリケーションに対してリアルタイムにデータを送信することができます。このため、何か変更や追加が発生していないかどうか、確認する処理を定期的に繰り返し実行する必要がありません。取得対象の新しい情報が発生したときに、該当の情報が発生したアプリケーションから、その情報を必要とするアプリケーション側にデータを自動で送信します（技術的には、連携先のアプリケーションのWebhook URLを呼び出します）。これが、Webhookの主な仕組みです。 

利点：

  1. Webhookを使用すると、連携対象のアプリケーションにおいて特定の処理が発生した際に、すぐに通知や関連するデータを受け取ることができます。処理が発生していないかどうか、確認するためのAPI処理を定期的に繰り返し実行する必要はありません。Webhookの設定するだけで、処理の発生時に自動的に通知を取得できます。 
  2. Webhookによって処理を自動化でき、生産性を大幅に向上できます。APIの場合は、取得時点の情報が最新でない場合もありますが、Webhookの場合は必ず最新の情報を取得できます。Webhookを設定すると、訪問者がチャットを開始したり、チャットに返信したりなどの特定の操作を行ったときに自動で通知を受け取ることができます。

Webhookの作成と管理

こちらに記載されているREST APIを使用して、Webhookを作成、管理できます。 

信頼できるソースの検証（署名を使用）：

公開鍵の用途と生成方法
Zoho SalesIQでは、Webhookを通じて連携先のURL（エンドポイントURL）に対して送信されるすべてのデータについて、PSA暗号システムを使用した署名が行われます。
  1. 署名アルゴリズムとして、SHA256 with RSAが使用されます。
  2. 署名は、Base64でエンコードされます。
  3. 文字コードは、UTF-8が使用されます。
作成された公開鍵は、連携先（エンドポイント）のサーバーにコピーされ、保存されます。その後、署名付きで受信したデータの信頼性チェックに使用されます。Zohoでは、公開鍵と秘密鍵のペアが作成されます。
公開鍵を生成するには、次のAPIを使用します：
  1. API：/api/v2/{screenname}/webhooks/{id}/keys
  2. メソッド：POST
  3. スコープ：SalesIQ.webhooks.CREATE
公開鍵を削除するには、次のAPIを使用します：
  1. API：/api/v2/{screenname}/webhooks/{id}/keys/{keyid}
  2. メソッド：DELETE
  3. スコープ：SalesIQ.webhooks.DELETE 
信頼できるソースの検証とは、Webhookをより安全に利用するための仕組みです。APIのレスポンス（応答）で公開鍵を取得し、データに関するリクエストのx-siqsignatureヘッダーにある署名を検証することで、連携サービスのデータがZoho SalesIQから送信されたことを確認できます。署名が有効な場合、ソースは信頼できると言えます。このプロセスは、Webhookを不正アクセスから保護するためのものです。

署名ヘッダーを使用してソースを検証するには：
  1. ヘッダー： 
  2. {
  3. x-siqsignature : $signature 
  4. }
安全に使用できるようにコールバックを設定するには、Webhookを作成し、安全な処理に関するパラメーターを「true」に設定します（"secured:true"）。
  1. ペイロード： 
  2. {
  3. webhook : {
  4. url : $webhookurl,
  5. secured : <boolean>},
  6. published : <boolean>
  7. } 
メモ：
  1. ポータルごとに管理できるWebhook数の上限は、3件です
  2. Webhookの自動再試行回数の上限は、3回です
  3. 再試行の自動実行は、1分後です
  4. 実行ごとのタイムアウトは、5秒です
  5. 初期設定のエラーログの保持期間は、60日間です
  6. Webhookを利用できるのは、エンタープライズプランのみです

Webhookのペイロード（送信データ）

あらかじめ指定しておいた処理がZoho SalesIQで発生したときに、Webhookが呼び出されます。たとえば、「conversation.visitor.replied」という処理を設定した場合、訪問者がチャットに返信すると、関連情報を含む通知が届きます。 

ペイロードの設定：

  1. version：Webhookのペイロードのバージョン
  2. event：通知された処理
  3. event_time：処理が発生した日時
  4. org_id：Zoho SalesIQのポータルID
  5. app_id：埋め込みID（データの更新に関する処理でのみ使用可能）
  6. attempt：Webhookを通じて処理の通知が実行された試行回数
  7. entity：発生した処理の対象
  8. entity_type：対象の種類（例：ボット、部門、担当者）
  9. entity_id：対象の一意のID例：チャットに関する処理の場合、チャットID
  10. modified_fields：変更された属性の一覧
ペイロードは、以下の形式で受信する必要があります。
  1. {
  2. "version" : "1",
  3. "event" : "operator.created",
  4. "event_time" : $time of event,
  5. "org_id" : $soid,
  6. "app_id" : $appid,
  7. "attempt" : $count of retry,
  8. "entity_type" : $type of entity,
  9. "entity_id" : $ID,
  10. "entity" : {
  11. $ENTITY 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.  "version":"1",
  8. "app_id":8000000000047,
  9.  "entity":{
  10.       "id":"8000000004009",
  11.       "message":{
  12.       "sender":{
  13.       "name":"Tricia",
  14.       "id":"8000000000005"
  15. },
  16.  "msgid":"1566480708251",
  17.  "text":"配送状況について確認したいことがあります。"
  18. }
  19. },
  20.  "event_time":1566480708268
  21. }

処理：

Webhookを使用すると、サーバーで特定の処理が発生したときに、通知を受け取ることができます。以下の一覧の処理を指定しておくと、それぞれの処理が発生したときに、通知を受け取ることができるようになります。 

Webhookの対象データ：

以下の種類のデータを利用できます。該当のデータに関連する処理が発生したときに通知を受け取れます。 
  1. チャット：チャットでは、Webサイトの訪問者とやりとりしたメッセージを確認できます。チャットのデータには、訪問者や担当者のメッセージ、対応した担当者、チャットに割り当てられた管理者やスーパーバイザー、チャットに関連するその他の情報が含まれます。
  2. 部門：

チャット

チャットでは、Webサイトの訪問者とやりとりしたメッセージを確認できます。チャットのデータには、訪問者や担当者のメッセージ、対応した担当者、チャットに割り当てられた管理者やスーパーバイザー、チャットに関連するその他の情報が含まれます。

チャットに関する処理の一覧：
  1. conversation.created
  2. conversation.attender.updated
  3. conversation.missed
  4. conversation.completed
  5. conversation.rated
  6. conversation.visitor.replied
  7. conversation.operator.replied

conversation.created

訪問者がチャットを開始したときに通知を受け取る場合は、この処理を使用します。

  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.   "owner": {
  14.     "id": "30102333033335",
  15.     "name": "Patricia",
  16.     "email_id": "patricia@zylker.com"
  17.   },
  18.   "visitor":{
  19.         "email_id":"tricia@zylker.com",
  20.         "phone":"1234354",
  21.         "name":"Tricia",
  22.         "type" : "contact",
  23.         "id": "30000000090034"
  24.   },
  25.   "question": "商品ABCの購入について確認したいことがあります。",
  26.   "supervisors": [
  27.     "30102333033336",
  28.     "30102333033337"
  29.   ],
  30.   "participants": [
  31.     "30102333033336",
  32.     "30102333033337"
  33.   ],
  34.   "status": "Live",
  35.   "chat_status": {
  36.     "status_code": [
  37.       "1,2"
  38.     ],
  39.     "state": [
  40.       "1,2,3,4"
  41.     ],
  42.     "label": "Live"
  43.   }
  44. }

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.   "owner": {
  15.     "id": "30102333033335",
  16.     "name": "Patricia",
  17.     "email_id": "patricia@zylker.com"
  18.   },
  19.   "visitor":{
  20.         "email_id":"tricia@zylker.com",
  21.         "phone":"124534354",
  22.         "name":"Tricia",
  23.         "type" : "contact",
  24.         "id": "30000000090034"
  25.      }
  26.   },
  27.   "question": "商品ABCの購入について確認したいことがあります。",
  28.   "supervisors": [
  29.     "30102333033336",
  30.     "30102333033337"
  31.   ],
  32.   "participants": [
  33.     "30102333033336",
  34.     "30102333033337"
  35.   ],
  36.   "status": "Connected",
  37.   "chat_status": {
  38.     "status_code": [
  39.       "1,2"
  40.     ],
  41.     "state": [
  42.       "1,2,3,4"
  43.     ],
  44.     "label": "Attended Online"
  45.   }
  46. }

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.   "owner": {
  14.     "id": "30102333033335",
  15.     "name": "Patricia",
  16.     "email_id": "patricia@zylker.com"
  17.   },
  18.   "visitor":{
  19.         "email_id":"tricia@zylker.com",
  20.         "phone":"12344354",
  21.         "name":"Tricia",
  22.         "type" : "contact",
  23.         "id": "30000000090034"
  24.   },
  25.   "question": "商品ABCの購入について確認したいことがあります。",
  26.   "supervisors": [
  27.     "30102333033336",
  28.     "30102333033337"
  29.   ],
  30.   "participants": [
  31.     "30102333033336",
  32.     "30102333033337"
  33.   ],
  34.   "status": "Missed",
  35.   "chat_status": {
  36.     "status_code": [
  37.       "1,2"
  38.     ],
  39.     "state": [
  40.       "1,2,3,4"
  41.     ],
  42.     "label": "Tracked in CRM"
  43.   }
  44. }

conversation.operator.replied

訪問者が開始したチャットに担当者が返信したときに通知を受け取るには、この処理を使用します。

  2. ペイロード：

  4. {
  5. "id":"8000000004009",
  6. "message":{
  7. "sender":{
  8. "name":"Tricia",
  9. "id":"8000000000005"
  10. },
  11. "msgid":"1566480708251",
  12. "text":"商品ABCの購入について確認したいことがあります。"
  13. },
  14. "visitor":{
  15. "email_id":"tricia@zylker.com",
  16. "phone":"12344354",
  17. "name":"Tricia",
  18. "type" : "contact",
  19. "id": "30000000090034"
  20. },
  21. "owner":{
  22. "id":"30102333033335",
  23. "name":"Patricia",
  24. "email_id":"patricia@zylker.com"
  25. },
  26. "version":1
  27. }

  29. ボットによるチャットのペイロード：

  31. {
  32. message : {
  33. "sender" : {
  34. "id" : $sender wms id,
  35. "name" : $sender name
  36. },
  37. "text" : $msg, // Absent for bot message
  38. "msgid" : $msg id, // Absent for bot message
  39. "meta" : $meta data, --->ボットのメッセージも適用可
  40. "list" : [
  41. $MESSAGE LIST
  42. ]

  44. }
  45. }

conversation.visitor.replied

訪問者が返信したときに通知を受け取るには、この処理を使用します。

  2. ペイロード：

  4. {
  5.   "id": "8000000005001",
  6.   "message": {
  7.     "sender": {
  8.       "name": "Tricia",
  9.       "id": "$2463902591169630574"
  10.     },
  11.     "msgid": "1566481170562",
  12.     "text": "商品ABCの購入について確認したいことがあります。"
  13.   },
  14.   "owner": {
  15.     "id": "30102333033335",
  16.     "name": "Patricia",
  17.     "email_id": "patricia@zylker.com"
  18.   },
  19.   "visitor":{
  20.         "email_id":"tricia@zylker.com",
  21.         "phone":"1234354",
  22.         "name":"Tricia",
  23.         "type" : "contact",
  24.         "id": "30000000090034"
  25.   },
  26.   "version": 1
  27. }

conversation.completed

チャットが終了したときに通知を受け取るには、この処理を使用します。

  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.   "owner": {
  14.     "id": "30102333033335",
  15.     "name": "Patricia",
  16.     "email_id": "patricia@zylker.com"
  17.   },
  18.   "visitor":{
  19.      "email_id":"tricia@zylker.com",
  20.      "phone":"12344354",
  21.      "name":"Tricia",
  22.      "type" : "contact",
  23.      "id": "30000000090034"
  24.   },
  25.   "question": "商品ABCの購入について確認したいことがあります。",
  26.   "supervisors": [
  27.     "30102333033336",
  28.     "30102333033337"
  29.   ],
  30.   "participants": [
  31.     "30102333033336",
  32.     "30102333033337"
  33.   ],
  34.   "status": "Closed",
  35.   "chat_status": {
  36.     "status_code": [
  37.       "1,2"
  38.     ],
  39.     "state": [
  40.       "1,2,3,4"
  41.     ],
  42.     "label": "Attended by Email"
  43.   }
  44. }

conversation.rated

訪問者が担当者とのチャットのやりとりについて評価したときやフィードバックを送信したときに通知を受け取るには、この処理を使用します。

  2. 評価のペイロード：
  3. {
  4.   "rating": 4,
  5.   "feedback": "素晴らしいサポートでした！",
  6.   "owner": {
  7.     "id": "30102333033335",
  8.     "name": "Patricia",
  9.     "email_id": "patricia@zylker.com"
  10.   },
  11.   "visitor":{
  12.         "email_id":"tricia@zylker.com",
  13.         "phone":"12344354",
  14.         "name":"Tricia",
  15.         "type" : "contact",
  16.         "id": "30000000090034"
  17.   }
  18. }

  20. フィードバックのペイロード：

  22. {
  23.   "entity_type": "conversation",
  24.   "org_id": "55778119",
  25.   "event": "conversation.rated",
  26.   "entity_id": "40526000001808033",
  27.   "attempt": 1,
  28.   "version": "1",
  29.   "app_id": 40526000000002040,
  30.   "entity": {
  31.     "owner": {
  32.       "name": "Patricia",
  33.       "email_id": "patricia@zylker.com"
  34.       "id": "40526000000002001"
  35.     },
  36.     "feedback": "素晴らしいサポートでした！",
  37.     "id": "40526000001808033",
  38.     "status": "Ended",
  39.     "visitor":{
  40.         "email_id":"tricia@zylker.com",
  41.         "phone":"12344354",
  42.         "name":"Tricia",
  43.         "type" : "contact",
  44.         "id": "30000000090034"
  45.        }
  46.   },
  47.   "event_time": "1567065865617"
  48. }

部門：

Zoho SalesIQのWebhookには、2種類の処理を指定できます：データの更新に関する処理、管理者の操作に関する処理。部門に関するWebhookを追加する場合、［管理者の操作］を選択します。部門に関する処理の一覧は以下のとおりです。

部門に関する処理の一覧：
  1. department.created
  2. department.deleted
  3. department.updated

department.created

ポータルで新しい部門が作成されたときに通知を受け取るには、この処理を使用します。

  2. ペイロード：

  4. {
  5.   "entity_type": "department",
  6.   "org_id": "55778119",
  7.   "event": "department.created",
  8.   "entity_id": "40526000001808025",
  9.   "attempt": 1,
  10.   "version": "1",
  11.   "entity": {
  12.     "is_enabled": "true",
  13.     "created_time": "1571032858870",
  14.     "modified_time": "1571032858870",
  15.     "operators": [
  16.       "6000000000005"
  17.     ],
  18.     "is_system_generated": "false",
  19.     "name": "Support",
  20.     "is_public": "true",
  21.     "email_configurations": {
  22.       "missedchat_recipients": "",
  23.       "cc_recipients": "",
  24.       "is_blockip_mail_enabled": "true",
  25.       "from_email": "tricia@zylker.com",
  26.       "transcript_recipients": "tricia@zylker.com",
  27.       "is_feedback_mail_enabled": "true",
  28.       "blockip_recipients": "",
  29.       "feedback_recipients": "",
  30.       "is_missedchat_mail_enabled": "true",
  31.       "is_cc_mail_enabled": "true",
  32.       "is_transcript_mail_enabled": "true"
  33.     },
  34.     "description": "Webサイトからの質問に対応するサポート部門です",
  35.     "id": "6000000009015",
  36.     "display_name": "Zylker-support",
  37.     "created_by": "6000000000005"
  38.   },
  39.   "event_time": "1567065647511"
  40. }

department.deleted

ポータルで部門が削除されたときに通知を受け取るには、この処理を使用します。 

  2. ペイロード：

  4. {
  5.   "entity_type": "department",
  6.   "org_id": "55778119",
  7.   "event": "department.deleted",
  8.   "entity_id": "40526000001808025",
  9.   "attempt": 1,
  10.   "version": "1",
  11.   "event_time": "1567065647511"
  12. }

department.updated

部門の詳細が更新されたときに通知を受け取るには、この処理を使用します。

  2. ペイロード：

  4. {
  5.   "entity_type": "department",
  6.   "org_id": "55778119",
  7.   "event": "department.updated",
  8.   "entity_id": "40526000001808025",
  9.   "attempt": 1,
  10.   "version": "1",
  11.   "entity": {
  12.     "is_enabled": "true",
  13.     "created_time": "1571032858870",
  14.     "modified_time": "1571032858870",
  15.     "operators": [
  16.       "6000000000005"
  17.     ],
  18.     "is_system_generated": "false",
  19.     "name": "Support",
  20.     "is_public": "true",
  21.     "email_configurations": {
  22.       "missedchat_recipients": "",
  23.       "cc_recipients": "",
  24.       "is_blockip_mail_enabled": "true",
  25.       "from_email": "tricia@zylker.com",
  26.       "transcript_recipients": "tricia@zylker.com",
  27.       "is_feedback_mail_enabled": "true",
  28.       "blockip_recipients": "",
  29.       "feedback_recipients": "",
  30.       "is_missedchat_mail_enabled": "true",
  31.       "is_cc_mail_enabled": "true",
  32.       "is_transcript_mail_enabled": "true"
  33.     },
  34.     "description": "Webサイトからの質問に対応するサポート部門です",
  35.     "id": "6000000009015",
  36.     "display_name": "Zylker-support",
  37.     "created_by": "6000000000005"
  38.   },
  39.   "event_time": "1567065647511"
  40. }

担当者

Zoho SalesIQのWebhookには、2種類の処理を指定できます：データの更新に関する処理、管理者の操作に関する処理。担当者に関するWebhookを追加する場合、［管理者の操作］を選択します。担当者に関する処理の一覧は以下のとおりです。

担当者に関する処理の一覧：
  1. operator.created
  2. operator.updated
  3. operator.deleted
  4. operator.departments.associated
  5. operator.departments.dissociated

operator.created

組織に新しい担当者が追加されたときに通知を受け取るには、この処理を使用します。

ペイロード：
  1. {
  2.     "entity_type": "operator",
  3.     "org_id": "15188410",
  4.     "event": "operator.created",
  5.     "entity_id": "115000000029087",
  6.     "attempt": 1,
  7.     "version": "1",
  8.     "entity": {
  9.         "email_id": "patricia@zylker.com",
  10.         "access_levels": [
  11.             "chat",
  12.             "tracking"
  13.         ],
  14.         "role": "Administrator",
  15.         "signature": "2e8132839ffef039e24ab8e162b5b1f1",
  16.         "date_of_birth": "",
  17.         "description": "",
  18.         "language": "",
  19.         "chat_enabled": true,
  20.         "type": "Salesiq User",
  21.         "locale": "",
  22.         "confirmed": false,
  23.         "enabled": true,
  24.         "notify": {
  25.             "return_visit": false,
  26.             "new_visit": false
  27.         },
  28.         "modified_time": "1596093400214",
  29.         "id": "115000000029087",
  30.         "departments": [
  31.             "115000000004001",
  32.             "115000000000018"
  33.         ],
  34.         "first_name": "",
  35.         "owner": false,
  36.         "created_time": "1596093400198",
  37.         "time_format": "12 hours",
  38.         "address": {
  39.             "country": "",
  40.             "pincode": "",
  41.             "city": "",
  42.             "street": "",
  43.             "state": ""
  44.         },
  45.         "maximum_concurrent_chat": "none",
  46.         "image_url": "",
  47.         "mobile": "",
  48.         "last_name": "",
  49.         "time_zone": "",
  50.         "locale_country": "",
  51.         "deleted": false,
  52.         "phone": "",
  53.         "nick_name": "Patricia",
  54.         "social_media": {
  55.             "twitter": {
  56.                 "profile_url": ""
  57.             },
  58.             "linkedin": {
  59.                 "profile_url": ""
  60.             },
  61.             "enabled": false
  62.         },
  63.         "status": "Available"
  64.     },
  65.     "event_time": "1596093402483"
  66. }

operator.updated

担当者の設定が修正されたときに通知を受け取るには、この処理を使用します。

ペイロード：
  1. {
  2.     "entity_type": "operator",
  3.     "org_id": "15188410",
  4.     "event": "operator.updated",
  5.     "entity_id": "115000000000094",
  6.     "attempt": 1,
  7.     "version": "1",
  8.     "entity": {
  9.         "email_id": "patricia@zylker.com",
  10.         "access_levels": [
  11.             "chat",
  12.             "tracking"
  13.         ],
  14.         "role": "Administrator",
  15.         "signature": "2e8132839ffef039e7eaaa00748b47ec",
  16.         "date_of_birth": "",
  17.         "description": "",
  18.         "language": "en",
  19.         "chat_enabled": true,
  20.         "type": "Salesiq User",
  21.         "locale": "en",
  22.         "confirmed": true,
  23.         "enabled": true,
  24.         "notify": {
  25.             "return_visit": false,
  26.             "new_visit": false
  27.         },
  28.         "modified_time": "1596092957234",
  29.         "id": "115000000000094",
  30.         "departments": [
  31.             "115000000000018"
  32.         ],
  33.         "first_name": "Patricia",
  34.         "owner": false,
  35.         "created_time": "1594720783132",
  36.         "time_format": "12 hours",
  37.         "address": {
  38.             "country": "us",
  39.             "pincode": "625012",
  40.             "city": "Malibu",
  41.             "street": "Pacific Coast Highway",
  42.             "state": "California"
  43.         },
  44.         "maximum_concurrent_chat": "none",
  45.         "image_url": "",
  46.         "mobile": "08903694722",
  47.         "last_name": "Smith",
  48.         "time_zone": "United States/California",
  49.         "zuid": "15102744",
  50.         "locale_country": "us",
  51.         "deleted": false,
  52.         "phone": "1234567890",
  53.         "nick_name": "Patricia",
  54.         "social_media": {
  55.             "twitter": {
  56.                 "profile_url": ""
  57.             },
  58.             "linkedin": {
  59.                 "profile_url": ""
  60.             },
  61.             "enabled": false
  62.         },
  63.         "status": "Available"
  64.     },
  65.     "event_time": "1596092957257"
  66. }

operator.deleted

担当者が削除されたときに通知を受け取るには、この処理を使用します。

ペイロード：
  1. {
  2.    "entity_type": "operator",
  3.    "org_id": "15188410",
  4.    "entity_id": "115000000029087",
  5.    "event": "operator.deleted",
  6.    "version": "1",
  7.    "attempt": 1,
  8.    "event_time": "1596093526367"
  9. }

訪問者

Zoho SalesIQのWebhookには、2種類の処理を指定できます：データの更新に関する処理、管理者の操作に関する処理。訪問者に関するWebhookを追加する場合、［データの更新］を選択します。訪問者に関する処理の一覧は以下のとおりです。

訪問者に関する処理の一覧：
  1. visitor.updated

visitor.updated

訪問者情報が更新されたときに通知を受け取るには、この処理を使用します。

例1：見込み客の情報が更新されたときに、このペイロードを受け取ります。

ペイロード：
  1. {
  2.     "id": "30000000095001",
  3.     "type": "lead ",
  4.     "first_name": "Scott",
  5.     "last_name": "Smith",
  6.     "modifier": {
  7.         "type": "operator",
  8.         "email_id": "patricia@zylker.com",
  9.         "name": "patricia@zylker.com",
  10.         "id": "30000000099007"
  11.     }
  12. }
例2：見込み客に連絡先情報が追加されたときに、このペイロードを受け取ります。

メモ：メールアドレスや電話番号などの情報が追加されると、見込み客が連絡先に変換されます。

ペイロード：
  1. {
  2.     "id": "30000000095001",
  3.     "type": "contact",
  4.     "first_name": "Scott",
  5.     "last_name": "Smith",
  6.     "email_id": "scottsmith@zylker.com",
  7.     "phone": "9123459876",
  8.     "lead": {
  9.         "id": "30000000090034"
  10.     },
  11.     "modifier": {
  12.         "type": "operator",
  13.         "email_id": "patricia@zylker.com",
  14.         "name": "patricia@zylker.com",
  15.         "id": "30000000099007"
  16.     }
  17. }
例3：連絡先情報が更新されたときに、このペイロードを受け取ります。

ペイロード：
  1. {
  2.     "id": "30000000095001",
  3.     "type": "contact",
  4.     "first_name": "Scott",
  5.     "last_name": "Smith",
  6.     "email_id": "scottsmith@zylker.com",
  7.     "phone": "91234598121",
  8.     "modifier": {
  9.         "type": "operator",
  10.         "email_id": "patricia@zylker.com",
  11.         "name": "patricia@zylker.com",
  12.         "id": "30000000099007"
  13.     }
  14. }

Webhookの設定方法

Webhookを設定するには：
  1. Zoho SalesIQの上部アイコンから、［設定］→［開発者向け情報］→［Webhook］の順に移動します。
  2. ［管理者の操作］タブと［データの更新］タブのそれぞれで、Webhookを通じて通知する対象のポータル別の処理、またはチャットコード別の処理を設定できます。処理が発生したときに、指定したURLにデータを送信して通知できます。


［管理者の操作］タブに、ポータル別のWebhookを追加するには

［管理者の操作］タブ内で、ポータルの処理に基づくWebhookを作成する必要があります。Webhookを作成すると、ポータルの処理が発生したときに通知を受け取ることができるようになります。新しいWebhookを追加するには：
  1. ［追加する］ボタンをクリックします。
  2. データ送信先のURLを入力します。
  3. Webhookに関連付ける処理を選択します。



  4. 最後に、［Webhookを作成する］をクリックすると、Webhookが作成されます。 
  5. また、こちらではWebhookの手順を確認することもできます。


［管理者の操作］タブで、ポータル別のWebhookを削除するには

Webhookを削除するには：
  1. Webhookの一覧で、削除するWebhookにカーソルを合わせると右側に表示されるごみ箱（削除）アイコンをクリックします。



  2. 確認メッセージが表示されます。［削除する］をクリックすると、Webhookが削除されます。


［管理者の操作］タブで、Webhookを有効／無効にするには

Webhookを有効／無効にするには：
  1. 対象のWebhookの右側にある切り替えボタンをクリックします。


［データの更新］タブに、チャットコード別のWebhookを追加するには

［データの更新］タブ内で、チャットの処理に基づくWebhookを作成する必要があります。Webhookを作成すると、チャットの処理が発生したときに通知を受け取ることができるようになります。新しいWebhookを追加するには：
  1. ［追加する］ボタンをクリックします。
  2. Webhookを作成する対象のZoho SalesIQのアプリを選択します。



  3. データ送信先のURLを入力します。
  4. Webhookに関連付ける処理を選択します。



  5. 最後に、［Webhookを作成する］をクリックすると、Webhookが作成されます。
  6. また、こちらではWebhookの手順を確認することもできます。



［データの更新］タブで、チャットコード別のWebhookを削除するには

Webhookを削除するには：
  1. Webhookの一覧で、削除するWebhookにカーソルを合わせると右側に表示されるごみ箱（削除）アイコンをクリックします。



  2. 確認メッセージが表示されます。［削除する］をクリックすると、Webhookが削除されます。



データタブでWebhookを有効／無効にする方法

Webhookを有効／無効にするには：
  1. 対象のWebhookの右側にある切り替えボタンをクリックします。


Webhookの一覧ページ：

Webhookの一覧ページでは、次の詳細を確認できます：
  1. 失敗：Webhookを実行できなかった回数です。
  2. 最終実行日：Webhookを最後に実行した日付です。
  3. アプリ：Webhookが関連付けられているアプリの一覧です。


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

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

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

    Zoho CRM Training




              Zoho Desk Resources

              • Desk Community Learning Series


              • Digest


              • Functions


              • Meetups


              • Kbase


              • Resources


              • Glossary


              • Desk Marketplace


              • MVP Corner


              • Word of the Day






                        Latest Feature Updates



                                • Related Articles

                                • LINEとZoho SalesIQの連携

                                  LINEとZoho SalesIQの連携機能を利用すると、顧客が利用している端末（デバイス）のLINEアプリから担当者宛てにメッセージを送信してもらえるようになります。また、担当者は顧客からのLINEメッセージにZoho SalesIQの画面から対応することができます。 LINE連携の初期設定 LINE連携の利用を開始するには、以下の手順を実施します。 Zoho ...

                                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.