Webhook(Web通知)の作成

Webhook(Web通知)の作成

Webhook(Web通知)は、Zoho CRMでイベントが発生するたびにすぐに実行するWeb通知を送信して、外部アプリケーションと通信できます。Webhook(Web通知)を使用すると、HTTP URLを設定してワークフロールールに関連付け、通知プロセス全体を自動化できます。Webhookの一般的な情報については webhooks.org をご参照ください。

利用例 

  • Zoho CRMで商談を受注すると、会計ソフトウェア( Zoho Books など)に顧客情報を送信し、その顧客の請求書を自動生成できます。
  • Zoho CRMのWebフォームを使用して、Webサイトから獲得した見込み客や連絡先に基づき、メールマーケティングソフトウェア(MailChimpなど)のメーリングリストに登録者を追加できます。
  • 顧客との会議、デモ、その他の予定について、外回り営業担当者にSMSリマインダーを自動送信できます。
  • 商談ステージが潜在顧客から価格見積りに変更されると、すぐに会計ソフトウェア(Zoho Booksなど)で見積書を自動生成できます。
  • Zoho CRMで商談を受注すると、 Zoho Creator で作成した営業手数料アプリケーションで、営業担当者の手数料を自動計算できます。

対象者

  • ワークフローの管理権限を持つZoho CRMユーザー
  • REST APIスキルを持つプログラマー

利用条件  

必要な権限 
ワークフローの管理権限を持つユーザーが、この機能にアクセスできます。
 

Webhook(Web通知)の項目の一覧

項目名
詳細
データ型
上限
名前
Webhook(Web通知)名を入力します。
テキスト
英数字(100文字)
詳細
Webhook(Web通知)の詳細を追加します。
テキスト
200文字
通知先のURL
外部アプリケーションのREST API URLを指定します。
URL
300文字
メソッド
APIメソッドのタイプとして、POSTまたはGETを選択します。デフォルトでは、POSTメソッドが選択されています。
ラジオボタン
-
タブ

Zoho CRMタブを選択します。

対応しているタブ

  • 見込み客、取引先、連絡先、商談など、CRMの主要タブ。
  • 予定とタスク

注: 通話の記録とメモのタブには、Webhook(Web通知)を設定できません。

選択リスト
-
追加エンティティパラメーター

パラメーター名と、対応するパラメーター値を指定します。外部アプリケーションにWebhook(Web通知)通知を実行するときに送信される、リクエストパラメーターです。

対応しているタブ

  • CRMの主要タブ
  • ユーザー
  • 組織
文字列
3,000文字
追加カスタムパラメータ
Webhook(Web通知)のCRMパラメーター名と、対応する値を指定します。  Webhook(Web通知)を実行するときに送信される、リクエストパラメーターでもあります。名前と値は設定したとおりです。このキー/値のペアは、主に認証トークン、セキュリティートークンなどの送信に使用されます。
文字列
-
URLのプレビュー
外部アプリケーションに通知する完全なWebhook(Web通知)URLをプレビューできます。
テキスト
読み取り専用

Webhook(Web通知)の設定

Webhook(Web通知)を設定するには、次の3つの手順を実行します:

  • Webhook(Web通知)を作成する
  • Webhook(Web通知)をワークフロールールに関連付ける
  • Webhook(Web通知)連携をテストする

Webhook(Web通知)を作成するには

  1. [設定] > [自動化] > [処理] > [Webhook(Web通知)] に移動します。
  2. [Webhook(Web通知)] ページで、 [Webhook(Web通知)の設定] をクリックします。
  3. [新しいWebhook(Web通知)] ページで、必要なパラメーターをすべて指定します。
  4. [保存] をクリックします。



使用できない差し込み項目値の識別

Webhook(Web通知)の 値の詳細 の編集画面で使用した差し込み項目の値が、 ${unsupported_field} と表示される場合があります。これは、次のような理由で発生します。

カスタム項目の削除

値を挿入した差し込み項目が削除されています。Webhook(Web通知)の 値の詳細 の編集画面に、削除済み項目の差し込み項目値が引き続き含まれる場合、その値は ${Unsupported_Field} として表示されます。

カスタム検索項目の削除

値を挿入したカスタム検索項目が削除されています。Webhook(Web通知)の 値の詳細 の編集画面に、削除された検索項目の差し込み項目値が引き続き含まれる場合、その値は ${Unsupported_Field} として表示されます。

使用可能な差し込み項目のリストにない項目

選択したタブの使用可能な差し込み項目リストにはない項目の差し込み項目値を使用した場合、 ${Unsupported_Field} として表示されます。

たとえば[商談]タブの 値の詳細 の編集画面に、差し込み項目値${Leads.Lead Id}を挿入すると、使用できない項目として表示されます。 

連携/機能の無効化

アカウントの機能または連携が無効になっている場合は、連携の一部として作成された項目も、無効にした後のアカウントでは使用できません。このような項目の差し込み項目値が 値の詳細 の編集画面に挿入されている場合、 ${Unsupported_Field} として表示されます。これは、次の機能/連携に適用されます。

  • Google 広告連携 - 使用できなくなったGoogle広告項目は使用できません。
  • 訪問者追跡(Zoho SalesIQ連携) - 使用できなくなった訪問者追跡項目は使用できません。
  • テリトリー管理 - 使用できなくなったテリトリー管理項目は使用できません。
  • 複数通貨 - 無効にされた通貨は使用できません。

Webhook(Web通知)をワークフロールールに関連付けるには

  1. [設定] > [自動化] > [ワークフロールール] に移動します。
  2. [ワークフロールール] ページで、 [ルールの作成] をクリックします。
  3. [新しいルールの作成] ページで、ワークフロールールのパラメーターを指定します。
  4. [ワークフローの処理] でWebhook(Web通知)を選択します。
  5. [Webhook(Web通知)の呼び出し]ポップアップで、Webhook(Web通知)を選択して [関連付け] をクリックします。
  6. [保存] をクリックします。



Webhook(Web通知)連携をテストするには

  1. ワークフロールールの条件に従い、CRMにテストデータを追加します。
  2. アプリケーションで、Webhook(Web通知)を介してZoho CRMから受信したデータを確認します。
  3. エラーまたはデータの不一致がある場合は、Zoho CRMでWebhook(Web通知)の設定を変更します。
  4. 使用しているアプリケーションがZoho CRMから必要なデータを取得するまで、このテストを続けます。

重要事項

  • ワークフロールールごとに、最大6件までのWebhook(Web通知)(すぐに実行する処理を1件+時間基準処理を5件まで)を関連付けることができます。
  • Webhook(Web通知)を使用して、Zoho CRMから外部アプリケーションに、最大10件のCRM項目のデータを転送できます。
  • Webhook(Web通知)を使用して、他のアプリケーションからZoho CRMに、データを取得することはできません。
  • APIチケットは、外部アプリケーションの制限に従って、定期的に更新する必要があります。
  • 外部サービスAPIの問題が原因でWebhook(Web通知)連携が機能しなくなると、メール通知を受信できません。
  • Webhook(Web通知)では、POSTメソッドを使用している場合、ユーザー定義形式で最大10,000文字を使用できます。
  • プロセスに障害が発生した場合、Webhook(Web通知)は最初に通知を送信し、Zoho CRMシステムは15分後に2回目の通知を送信します。その後、システムはその特定のワークフロー実行に関するWebhook(Web通知)を送信しません。
  • 1日あたりの上限を超えた場合、残りのWebhook(Web通知)は外部アプリケーションには送信されず、管理者にエラーが通知されます。
  • [通知先のURL] 項目でポート番号を設定する場合、対応しているポート番号は「 80 」または「 443 」のみです。
  • Zoho CRMには、Webhook(Web通知)のパラメーター設定時に「 日付 / 日時 」形式と「 タイムゾーン 」を選択するオプションがあります。
  • 1日あたりのWebhook(Web通知)呼び出し回数の上限:
    • プロフェッショナルプラン - 50,000回/日、または、100回/日xユーザー数(いずれか少ない方)。
    • エンタープライズプラン - 500,000回/日、または、500回/日xユーザー数(いずれか少ない方)。 
    • アルティメットプラン - 1,000,000回/日、または、1,000回/日xユーザー数(いずれか少ない方)。  

ビジネスでの利用例1

Zoho CRMで機会が完了すると、Zoho Creatorアプリで販売手数料を計算できます。

目的

営業マネージャーと給与計算チームは、販売手数料アプリを使用して、組織が設定した定義済みの計算式(受注した契約または売上高の、一律2%など)に基づき営業担当者の報酬を計算できます。このアプリケーションを使用すると、営業担当者の販売手数料を計算する際に、手入力を減らしてエラーを最小限に抑え、時間を節約できます。また、営業担当者は月次の販売手数料を、一元的に追跡できます。

前提条件

  • Zoho Creatorアプリケーションのアカウント
  • Zoho APIへのアクセス権限
  • Zoho Creatorの知識

手順

  1. Zoho Creatorを使用して販売手数料アプリを作成する( アプリの作成 についてはZoho Creatorのチュートリアルをご参照ください)   
  2. Zoho CRMでWebhook(Web通知)を設定する
  3. ワークフロールールを設定する
  4. Webhook(Web通知)の連携をテストする            

手順1:Zoho Creatorで販売手数料アプリを作成する             

Zoho Creatorで、次の項目を含む販売手数料アプリを作成します: 

  • 営業担当者
  • 商談名
  • 顧客名
  • 商談の総額
  • 商談の種類:[新しいビジネス]または[既存ビジネス]
  • 受注日
  • 販売手数料

Zoho Creatorを使用したアプリケーションの作成については、Zoho Creatorのオンラインヘルプ をご参照ください。

手順2:Webhook(Web通知)を設定する

ユーザー定義パラメーターの設定時に、[商談]タブから次の項目を選択します:

  • 商談名
  • 受注日
  • 種類
  • データの担当者
  • 総額

Webhook(Web通知)で、次の詳細を指定します:

通知先のURL:

  1. https://creator.zoho.com/api/xml/write - POST メソッド

ユーザー定義パラメーター(XMLまたはJSON)

  1. <ZohoCreator>
  2.     <applicationlist>
  3.         <application name='sales-commissions'>
  4.             <formlist>
  5.                 <form name='Commissions'>
  6.                     <add>
  7.                         <field name='Name'>
  8.                             <value> ${Potentials.Potential Name} </value>
  9.                         </field>
  10.                         <field name='Closed_Amount'>
  11.                             <value> ${Potentials.Amount} </value>
  12.                         </field>
  13.                         <field name='Closing_Date'>
  14.                             <value> ${Potentials.Closing Date} </value>
  15.                         </field>
  16.                         <field name='Customer_Name'>
  17.                             <value> ${Accounts.Account Name} </value>
  18.                         </field>
  19.                         <field name='Type_of_Business'>
  20.                             <value> ${Potentials.Type} </value>
  21.                         </field>
  22.                         <field name='Sales_Rep'>
  23.                          <value> ${Potentials.Potential Owner} </value></field>
  24.                     </add>
  25.                 </form>
  26.             </formlist>
  27.         </application>
  28.     </applicationlist>
  29. </ZohoCreator> 
メモ 
  • 上記のXML文字列では、名前はZoho Creatorアプリの項目を表し、データ値はZoho CRMから送信されます。
  • <applicaton name>は、Zoho Creatorのフォームを含むアプリケーションの名前です。アプリケーションの名前は、Zoho Creatorの[アプリケーションの設定]タブから取得できます。
  • <form name>は、Zoho Creatorでデータを編集するフォームの名前です。フォームの名前は、Zoho Creatorアカウントのフォーム設定から取得できます。
  • Creatorアプリの日付形式が、yyyy-MM-dd形式であることを確認します。日付形式は、Zoho Creatorアカウントのアプリケーション設定から変更できます。

カスタムパラメーター:

パラメーター
詳細
authtoken*
Creatorアカウントから認証トークンを指定します。詳細については、 Zoho Creator APIのヘルプ をご参照ください。 
zc_ownername*
Creatorアカウントのアプリケーションの所有者名を指定します。  
メモ
  • 他のアプリからZoho Creatorにデータを取得するには、Zoho APIのユーザー名と認証トークンを指定する必要があります。Zoho API情報の生成については、 オンラインヘルプ をご参照ください。

手順3:ワークフロールールを設定する         

[ワークフロールール]ページで、次の手順を実行します:

  1. ワークフロー条件を次のように設定します: 
    • [種類]は [新しいビジネス]
    • [ステージ]は [受注]
  2. [次へ] をクリックします。



  3. すぐに実行する処理として、Webhook(Web通知)を選択します。
  4. [Webhook(Web通知)の呼び出し] ポップアップで、リストからWebhook(Web通知)を選択して [関連付け] をクリックします。
  5. ワークフロールールを保存します。 



ワークフロールールへのWebhook(Web通知)の関連付け

手順4:連携をテストする         

  1. CRMにテスト商談を追加します。[種類]項目は[新しいビジネス]、[ステージ]項目は[受注]に指定します。テストデータの入力時に、[総額]、[完了予定日]、[データの担当者]、[取引先名]、[商談名]も入力します。
  2. Zoho Creatorで販売手数料アプリを開き、CRMデータを確認します。
    データを受信していない場合は、Webhook(Web通知)の設定を変更して、テストを続けます。テストが正常に終了したら、テストデータを削除し、この連携をCRMユーザーに展開します。

ビジネスでの利用例2

顧客と営業担当者にSMSメール通知を送信できます。

目的

顧客からの支払いの期日が今日だとします。Webhook(Web通知)をワークフロールールの時間基準処理に関連付けることで、支払い期日、顧客名、総額の詳細を記載したSMSを営業担当者に送信できます。

前提条件

  • SMSゲートウェイサービスのアカウント
  • ワークフロールールへのアクセス権限

手順

  1. SMSゲートウェイサービスでアカウントを作成する           
  2. Zoho CRMでWebhook(Web通知)を設定する           
  3. ワークフロールールを設定する
  4. Webhook(Web通知)の連携をテストする           

手順1:SMSゲートウェイサービスでアカウントを作成する         

SMSゲートウェイサービスでアカウントを作成し、次の詳細を取得して、Webhook(Web通知)を設定します: 

  • 営業担当者
  • 商談名
  • 顧客名
  • 商談の総額
  • 商談の種類:新しいビジネス
  • ステージ:受注
  • 支払期限日(カスタム項目)

現在、Zohoは次のSMSゲートウェイサービスと提携しています:

上記の仕入先から、SMSクレジットとAPIの詳細を購入できます。

手順2:Webhook(Web通知)を設定する

ユーザー定義パラメーターの設定時に、[見込み客]タブから次の項目を選択します:

  • SMSゲートウェイのドメイン名
  • ユーザー名
  • 認証トークン

Webhook(Web通知)で、次の詳細を指定します:

通知先のURL:

  1. http://<Domain Name>/smsgateway/post - POSTメソッド

ユーザー定義パラメーター(XMLまたはJSON)

  1. <?xml version="1.0"?>
  2. <m:Library xmlns:m=" http://www.screen-magic.com%22/ xmlns="http://www.defns.com%22%3E/
  3. <username> xxxx@xxxxx.com </username>
  4. <senderid> SMS-Provider </senderid>
  5. <accountid> XXXXXXX </accountid>
  6. <authtoken> XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX </authtoken>
  7. <message mobilenumber="${User.Mobile}">こんにちは、${User.Last Name}さん。 ${Account.Name}へのお支払い金額「 ${Potential.Amount}」の期限が、今日までです。${Contact.Last Name}まで速やかに連絡します。 </message>
  8. </m:Library> 
メモ 
  • 上記のXML文字列では、デモ用にScreen Magicゲートウェイを使用しました。

手順3:ワークフロールールを設定する 

[ワークフロールール]ページで、次の手順を実行します:

  1. ワークフロー条件を次のように設定します: 
    • [種類]は  [新しいビジネス]
    • [ステージ]は  [受注]
    • [完了予定日]を選択します。 
  2. 時間基準の処理として、Webhook(Web通知)を選択します。
  3. ワークフロールールを保存します。

ワークフロールールの条件

 

ワークフロールールへのWebhook(Web通知)の関連付け


手順4:連携をテストする 

  1. CRMにテスト商談を追加します。そのとき、[種類]項目は[既存ビジネス]、[支払期限]項目は[今日]に指定します。テストデータの入力時に、[総額]、[完了予定日]、[データの担当者]、[取引先名]、[商談名]も入力します。
  2. 携帯電話でSMSメール通知を確認します。
    SMSを受信していない場合は、Webhook(Web通知)の設定を変更して、テストを続けます。テストが正常に終了したら、テストデータを削除し、この連携をCRMユーザーに展開します。 

エラーコードの参照

Webhook(Web通知)の実行に失敗すると、Zoho CRMに次のいずれかのエラーメッセージが表示されます:

HTTPステータスコード

  • Bad Request - 必須パラメーターが不足している場合があります。
  • Unauthorized Request  - 有効な認証トークンが指定されていません。
  • Request Failed - パラメーターは有効でしたが、リクエストに失敗しました。
  • Page Not Found - リクエストされた項目が存在しません。
  • Third-party error - 外部アプリケーションで問題が発生しました。
  • Third-party server not available - 外部サービスのAPIサーバーとの接続が切れました。
  • Internal process failure - Webhook(Web通知)の処理中にエラーが発生しました。
  • Day limit reached - 組織アカウントの1日あたりの上限に達しました。
  • Invalid URL - URLにSSRFの脆弱性があるか、無効なURLです。
  • Socket timeout - Webhook(Web通知)が呼び出されましたが、10秒間レスポンスを受信しませんでした。
     

Webhook(Web通知)の使用状況グラフの表示

Zoho CRMには、さまざまな機能におけるWebhook(Web通知)の使用状況を示す日次/週次統計グラフがあります。メール通知の使用状況は、 [設定] > [自動化] > [処理] > [Webhook(Web通知)]で表示できます。

使用状況の統計データについての詳細は、 [詳細情報] リンクを参照できます。グラフには、過去7日間の使用状況の統計データが表示されますのでご注意ください。



関連情報











                        • Related Articles

                        • ワークフローのタスクの作成

                          ワークフローのタスクは、ワークフロールールに関連付けられた処理です。タスクとは、ユーザーに割り当てられる活動のことです。ワークフローのタスクをワークフロールールに関連付けると、ルールの条件を満たすデータに対して、ルールが実行されると同時に、ワークフローのタスクがユーザーに自動で割り当てられます。 利用条件 必要な権限 ワークフローの管理権限を持つユーザーが、この機能にアクセスできます。  各プランの機能と制限を確認する  ワークフローのタスクを作成するには [設定] > [自動化] > [処理] ...
                        • 条件付きレイアウトの作成

                          Zoho CRMの条件付きレイアウトを使用すると、レイアウト内の項目の依存関係が管理しやすくなります。 営業データは、相互に依存していることがよくあります。次の例を考えてみましょう:  不動産会社では、購入したい物件の種類(マンションか別荘かなど)によって、顧客が必要とする項目が異なる場合があります。 教育機関では、選択する教科(物理学か経済学かなど)によって、学生が必要とする項目が異なる場合があります。 ...
                        • 取引先の作成

                          Zoho CRMでは、次の方法で取引先を作成できます: 取引先詳細フォームへのデータ入力 :さまざまな外部経路から収集した取引先詳細を手動で入力できます。 外部経路からの見込み客のインポート :さまざまな経路からデータを収集し、CSV、XLSファイルをZoho CRMにインポートできます。 取引先への見込み客の変換 :見込み客の変換時に、連絡先、取引先、商談を作成できます。 Microsoft Outlookの連絡先の同期 :Microsoft Outlookの連絡先をZoho ...
                        • 権限の作成

                          Zoho CRMの権限は、ユーザーに対して、各タブや操作に関する権限を設定するのに役立ちます。たとえば、営業担当者とマーケティング担当者では必要な権限が異なり、また、どちらも複数の担当者がいるとします。このような場合、「営業担当者」と「マーケティング担当者」の2つの権限を作成し、それぞれに必要な権限を設定して、対象のユーザーに割り当てることで、各担当者のZoho CRMの利用範囲を簡単に管理できます。 初期設定の権限 ...
                        • 商談の作成

                          Zoho CRMでは、次の方法で商談を作成できます: 商談フォームにデータを入力する : さまざまな外部ソースから収集した商談の詳細を手動で入力できます。 外部のデータ元から商談をインポートする :さまざまなソースからデータを収集し、CSVファイルとXLSファイルをZoho CRMにインポートできます。 見込み客を商談に変換する :見込み客の変換時に、連絡先、取引先、取引を作成できます。 メモ ...

                        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.