ウェブフック

ウェブフック

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

Webhookは、開発者によく利用されているコールバックメカニズムで、2つのアプリケーションを連携させる際に使用されます。イベントや操作が発生した際、統合されたアプリケーションにリアルタイムで通知を提供します。定期的なポーリングが必要なAPIベースのモデルと比べて、Webhookはより効率的で広く利用されている統合手法です。

Zoho Sign Webhook

Zoho Signでは、Webhookを設定してZoho Sign内で発生する処理のリアルタイム通知を受け取ることができます。

Event 送信済み 対象
説明
送信済み
ドキュメントが署名用に送信された際にトリガーされます。
Viewed
受信者のいずれかがドキュメントを閲覧した際にトリガーされます。
Signed by a recipient
受信者のいずれかによりドキュメントが署名または承認済みとなった際にトリガーされます。
完了 by すべて
全ての受信者によってドキュメントが完全に署名および承認済みとなった際にトリガーされます。
却下済み
受信者のいずれかによりドキュメントが却下済みとなった際にトリガーされます。
Reassigned
受信者のいずれかによって、署名または承認済みにするために他の人へドキュメントが再割り当てされた際にトリガーされます。
Expires
ドキュメントが署名用に送信され、承認の有効期限が切れた際にトリガーされます。
Recalled
ドキュメントが署名または承認用に送信された後、送信者によって取り消された際にトリガーされます。
承認済み
受信者のいずれかによってドキュメントが承認済みとなった際にトリガーされます。

前提条件:

  1. Webhookは現在、エンタープライズ、API、Zoho One、およびPeople Plusプランで利用可能です。
  2. 現時点では、1アカウントにつきWebhookは2つまで作成できます。

Webhookの登録方法:

  1. Zoho Signの管理者は、設定> Developer 設定> Webhookを左側の操作画面からクリックすることで、Webhookを登録できます。
  2. Webhook作成をクリックし、コールバックURLや名前などの必要な情報を入力します。また、このWebhookで実行する処理の一覧も表示されます。



  3. Webhookのセキュリティを強化したい場合は、HMAC署名のチェックボックスを有効にし、ご自身で作成したシークレットキーを入力してください。まだ作成していない場合は、生成するボタンをクリックしてください。
    Notes
    設定後は、保存されたシークレットキーをZoho Signから取得することはできません。
    シークレットキーはWebhookのデータ内容を認証するために必要となるため、必ず安全に管理してください。
  4. 該当する設定を選択し、Webhookの登録プロセスを完了してください。

Webhook データの内容:

  1. 各Webhookイベントに対して、以下のデータ内容が送信されます。
  2. このデータ内容は2つのキー「通知」と「requests」を持つJSONオブジェクトで、それぞれ内部にJSONオブジェクトを含みます。
  3. 通知オブジェクトには、ドキュメント上で実行された操作の詳細が、requestsオブジェクトにはWebhookが呼び出されたドキュメントの詳細が格納されています。

構造:

  1. {
  2. '通知':
  3. {
  4. 'performed_by_email': '<操作を実行した人物のメールアドレス>',
  5. 'performed_by_name': '<この操作を実行したユーザー>',
  6. 'performed_at': <時間値（java 現在時刻のミリ秒形式）>,
  7. '理由': '操作に対して記載された理由-適用対象がある場合',
  8. '活動': '実施された活動の説明,
    9. 実施された活動の説明,
  9. 'operation_type': 'RequestSubmitted | RequestViewed | RequestSigningSuccess | RequestCompleted | RequestRejected | RequestRecalled | RequestForwarded | RequestExpired',
  10. 'action_id': '
  11. 'ip_address': '<この操作中に取得されたIPアドレス> '
  12. },
  13. 'requests':
  14. {
  15. 'request_status': '<ドキュメントのステータス>',
  16. 'request_name': '<署名リクエストの名前>',
  17. 'request_id': '<長整数値 - 署名リクエストの主キー>',
  18. 'document_ids':
  19. [
  20. {
  21. 'document_name': '<署名リクエスト内のドキュメント名>',
  22. 'document_id': '<リクエスト内に含まれるドキュメントの長整数値>'
  23. }
  24. ]
  25. }
  26. }
    27.
活動の説明,< span>
活動の説明,< span>
サンプルデータの内容:
  1. {
  2. '通知':
  3. {
  4. 'performed_by_email': 'testuser@Zoho.com',
  5. 'performed_at': 1555062604837,
  6. '理由': '該当する場合の理由',
  7. '活動': 'ドキュメントが署名されました',
  8. 'operation_type': 'RequestSigningSuccess',
  9. 'action_id': '1000000000090',
  10. 'performed_by_name': 'テスト ユーザー',
  11. 'ip_address': '192。168。100。100'
  12. },
  13. 'requests':
  14. {
  15. 'request_name': 'NDA ドキュメント',
  16. 'request_id': '1000000000000',
  17. 'org_id': '9876543210',
  18. 'request_type_id': '10000000011',
  19. 'document_ids':
  20. [
  21. {
  22. 'document_name': 'CommonNDA。pdf',
  23. 'document_id': '100000000000050'
  24. }
  25. ]
  26. }
  27. }
メモ:
  1. 通知 JSON オブジェクト内の operation_type 属性には、処理をトリガーする以下のいずれかの定数を指定できます。この属性は、発生したイベントの種類を特定するうえで重要な役割を果たします。
操作タイプ
トリガーされる理由
RequestSubmitted
ドキュメントが署名用に送信されたとき。
RequestViewed
送信済みドキュメントが閲覧されたとき。
RequestSigningSuccess
署名者のいずれかが署名プロセスを正常に完了したとき。
RequestCompleted
すべての担当署名者または承認者が署名または承認プロセスを完了したとき。
RequestRejected
送信済み署名リクエストが却下されたとき。
RequestRecalled
送信済み署名リクエストが送信者によって取り消された場合。
RequestForwarded
割り当てられた署名者が送信済みリクエストを別の人に転送した場合。
RequestExpired
送信済みドキュメントが割り当てられた署名時間を超過した場合。

  1. RequestViewed、RequestSigningSuccess、RequestRejected、RequestForwardedなど署名者に関連する処理については、「通知」JSON内に署名者の'action_id'が含まれます。
  2. 通知データの内容として含まれるその他のデータはスタンダードデータ属性ではなく、今後予告なく削除される場合があります。ユーザーは、ドキュメント化されている属性のみを使用してください。



    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



                                  • Related Articles

                                  • ウェブフックのセキュリティ

                                    お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho Sign では、HMAC-SHA 256（SHA 256 を用いたハッシュベースのメッセージ認証コード）を利用して Webhook を保護するオプションを提供しています。これは業界標準のハッシュ方式であり、Webhook の信頼性と完全性を確保します。HMAC による ...

                                  • ウェブフックのベストプラクティス

                                    お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 技術系ユーザーとして、Webhookを使用してアプリケーションを設定または連携し、イベントや操作が発生した際にリアルタイムの更新を受け取ることができます。Zoho Signアカウントの管理者はWebhookを設定し、それをトリガーする処理を選択できます。 ...

                                  • 「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.