「ウェブフック」

「ウェブフック」

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

Webhookは開発者が2つのアプリケーションを統合するためによく使われるコールバックメカニズムの1つです。イベントやアクションが発生したときに、統合されたアプリケーションにリアルタイムで更新を提供します。これはAPIベースのモデルでは、このようなデータを定期的にポーリングする必要があるため、優れたソリューションです。Webhookは統合に関しては、より効率的で広く使われている方法論です。

Zoho Sign ウェブフック

Zoho Signは、Zoho Signで発生するイベントのリアルタイム更新を取得するためのWebhooksを設定するオプションを提供します。

イベント送信先
詳細
送信済み
署名のための文書が送信されたときにトリガーします。 
閲覧
受信者の一人がドキュメントを閲覧したときにトリガーされます。
受取人によって署名された
受取人の1人が署名または承認したときにトリガーされます。
すべての人によって完了されました 
すべての受信者が完全に署名および承認されたときにトリガーされます。
拒否
受信者のいずれかが文書を拒否したときにトリガーされます
再割り当て
受信者の1人が他の人に署名または承認するように文書を再割り当てしたときにトリガーされます。
有効期限
署名および承認のために送信された文書の期限が切れたときにトリガーします。
取り消し
署名または承認のために送信された文書が送信者によって取り消されたときにトリガーされます。

前提条件:

  1. Webhooksは、現在、Enterprise、API、Zoho One、People Plusプランで利用できます。
  2. 現在、1つのアカウントあたり2つのWebhooksのみが許可されています。

Webhookの登録方法:

  1. Zoho Signアカウントの管理者は、左側のナビゲーションパネルから設定をクリックし、API設定を選択してWebhookを登録することができます。
  2. 「Create webhook」をクリックし、コールバックURLと名前などの関連情報を提供します。 また、このWebhookがトリガーされるイベントのリストもあります。
  3. 関連するオプションを選択し、Webhookの登録プロセスを完了します。

  1. テストURLオプションは、指定されたコールバックURLにサンプルペイロードを送信します。これは構成と接続を検証するために使用されます。

ウェブフックペイロード：

  1. ウェブフックイベントごとに、以下のペイロードがトリガーされます。
  2. このペイロードは、2つのキー「notifications」および「requests」を内部に持つJSONオブジェクトです。
  3. notificationsオブジェクトは、ドキュメント上で実行されたアクションの詳細を提供し、requestsオブジェクトには、ウェブフックが呼び出されたドキュメントの詳細が含まれています。

構造:

  1. ｛
  2. '通知': 
  3. ｛
  4. 'performed_by_email': '<操作を実行した人のメールアドレスを記入してください。',
  5. 'performed_by_name': '<操作を実行したユーザー',
  6. 'performed_at': <java 現在時刻（ミリ秒形式）で表される時間の値>,
  7. '理由': '操作に関する理由（該当する場合）',
  8. '活動': '<小さな活動の説明>',
  9. 'operation_type': '要求が提出された | 要求が閲覧された | 署名が成功した | 要求が完了した | 要求が拒否された | 要求が取り消された | 要求が転送された | 要求が期限切れになった',
  10. 'action_id': '<サインアクションID',
  11. 'ip_address': '<この操作中にキャプチャされたIPアドレス>'
  12. 、
  13. 'リクエスト': 
  14. ｛
  15. 'request_status': '<ドキュメントの状態>',
  16. 'request_name': '<名前の署名リクエスト>',
  17. 'request_id': '<長い値 - 署名リクエストの主キー>',
  18. 'document_ids': ドキュメントID
  19. [ ]をクリックしてください。
  20. ｛
  21. 'document_name': '<署名リクエスト内の文書名>',
  22. 'document_id': '<長い値 - リクエスト内に含まれるドキュメント'
  23. }をクリックします。
  24. このヘルプガイドを使用して、技術的な問題を解決しましょう。
  25. }をご覧ください。
  26. }
サンプルペイロード：
  1. ｛
  2. '通知': 
  3. ｛
  4. 'performed_by_email': 'testuser@zoho.com',
  5. 'performed_by_email': 'testuser@zoho.com',
  6. 'performed_by_email': 'testuser@zoho.com',
  7. 'performed_by_email': 'testuser@zoho.com',
  8. 'performed_by_email': 'testuser@zoho.com',
  9. 'performed_by_email': 'testuser@zoho.com',
  10. 'performed_by_email': 'testuser@zoho.com',
  11. 'performed_by_email': 'testuser@zoho.com',
  12. 'performed_by_email': 'testuser@zoho.com',
  13. 'performed_by_email': 'testuser@zoho.com',
  14. 'performed_by_email': 'testuser@zoho.com',
  15. 'performed_by_email': 'testuser@zoho.com',
  16. 'performed_by_email': 'testuser@zoho.com',
  17. 'performed_by_email': 'testuser@zoho.com',
  18. 'performed_by_email': 'testuser@zoho.com',
  19. 'performed_by_email': 'testuser@zoho.com',
  20. 'performed_by_email': 'testuser@zoho.com',
  21. 'performed_at': 1555062604837,
  22. 'performed_at': 1555062604837,
  23. '理由': '言及されている場合は理由',
  24. '活動': 'ドキュメントが署名されました',
  25. 'operation_type': '署名の要求が成功しました',
  26. 'action_id': '1000000000090',
  27. 'action_id': '1000000000090',
  28. 'performed_by_name': 'テストユーザー',
  29. 'ip_address': '192.168.100.100'
  30. 'ip_address': '192.168.100.100'
  31. 、
  32. 'リクエスト': 
  33. ｛
  34. 'request_name': 'NDA文書',
  35. 'request_id': '1000000000000',
  36. 'request_id': '1000000000000',
  37. 'request_type_id': '10000000011',
  38. 'request_type_id': '10000000011',
  39. 'document_ids': ドキュメントID
  40. [］
  41. ｛
  42. 'document_name': 'CommonNDA.pdf',
  43. 'document_name': 'CommonNDA.pdf',
  44. 'document_id': '100000000000050'
  45. 'ドキュメントID': '100000000000050'
  46. }をご利用いただきありがとうございます。
  47. このヘルプガイドをご利用いただきありがとうございます。
  48. }をご利用いただきありがとうございます。
  49. }をご覧いただきありがとうございます。
注意：
  1. notification JSONオブジェクトのoperation_type属性は、アクションがトリガーされるプリ定義定数のいずれかを持つことができます。この属性は、起こったイベントの種類を特定するうえで重要な役割を果たします。
操作タイプ
トリガーの理由
要求が提出されました
署名のために文書が提出されたとき。
RequestViewed
提出書類が閲覧されたとき。
承認成功
サイン手続きを完了したいずれかの承認者が成功した時。
RequestCompleted
割り当てられた署名者または承認者が、署名または承認プロセスを完了した時。
リクエストが拒否された
送信された署名リクエストが拒否された場合。
RequestRecalled
送信者によって送信された署名リクエストが取り消されたとき。
RequestForwarded
割り当てられたサイン手がリクエストを別の人に転送したとき。
リクエスト期限切れ
提出された文書が割り当てられた署名時間を過ぎたとき。

  1. サイン関連のアクション（RequestViewed、RequestSigningSuccess、RequestRejected、RequestForwarded）の場合、'notifications' json内にサインする人の'action_id'があります。 
  2. 通知のペイロードに含まれる他のすべてのデータは標準データ属性ではなく、将来いつでも削除される可能性があります。 ユーザーは、記載された属性だけを使用するように指示されています。



    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

                                • 「Zoho SignウェブフックによってトリガーされるCRMにZoho Sign文書の詳細を追加するためのコールバック関数の設定方法」

                                  お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 シナリオ: ZohoCRMのカスタムモジュール内で、Zoho Signに文書を送信するオートメーションを設定しました。文書を表示するたびに、Zoho Signで文書を表示する必要があります。Zoho SignのWebhookによってトリガーされるCRMにZoho ...

                                • 「Webhooksのベストプラクティス」

                                  お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 テクニカルなユーザーとして、Webhookを使用してアプリケーションをセットアップまたは統合し、イベントまたはアクションが発生するたびにリアルタイムで更新を受け取ることができます。 Zoho ...

                                • 「21 CFR Part 11を使った文書の送信と署名」

                                  お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 企業版で利用可能で、アカウントで有効化が必要です Zoho Sign で 21 CFR Part 11 を有効化する： この操作は管理者によってのみ実行できます。Zoho Signアカウントで21 CFR Part 11を有効にするには、以下の手順に従ってください。 ...

                                • 「Make（旧Integromat）上のZoho Sign統合とワークフローオートメーション」

                                  お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 エンタープライズ/APIプランでのみ利用可能なアクション - Zoho Signクレジットを消費する Zoho ...

                                • 21 CFR Part 11- 概要

                                  お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 企業エディションで利用可能で、アカウントへの要求に応じて有効になります Zoho Signは、製薬、バイオテクノロジー、化粧品、食品・飲料など、FDA（米国食品医薬品局）によって規制されている業界で活動する企業や個人を対象として、21 CFR Part ...

                                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.