What is Webhooks?


Webhook is one of the popular call back mechanisms popularly used by developers to integrate any two applications. It provides updates in real-time to the integrated application whenever an event or action occurs. This is a superior solution, unlike in API based models where such data needs to be polled periodically. Webhook is a much more efficient and widely used methodology as far as integration is concerned.

Zoho Sign Webhooks

Zoho Sign provides option to configure webhooks to get real-time update of events that occur in Zoho Sign.

Event sent for
Triggers when documents are sent for signatures. 
Triggers when documents are viewed by one of the recipients.
Signed by a recipient
Triggers when documents are signed or approved by one of the recipients.
Completed by all 
Triggers when documents are completely signed and approved by all recipients.
Triggers when documents are declined by one of the recipients
Triggers when documents are reassigned by one of the recipients to be signed or approved by another person.
Triggers when documents are sent for signatures and the approval expires.
Triggers when documents are sent for signatures or approval are recalled by the sender.


  1. Webhooks, at present, are available on Enterprise, API, Zoho One, and People Plus plans.
  2. Currently, only two webhooks are allowed per account.

How to register a webhook:

  1. The Zoho Sign admin can register a webhook by clicking Settings > Developer Settings > Webhooks from the left navigation pane.
  2. Click Create webhook and provide relevant information like callback URL and name. It also has a list of events for which this webhook has to be triggered.

  3. If you wish to secure your webhook, enable the HMAC signature checkbox and enter the Secret key generated by you. If you don't have one, click the Generate button.
    Once configured, the saved secret key cannot be retrieved from Zoho Sign.
    You must take necessary steps to keep the secret key safe since the secret key is needed to validate the webhook payload in your application
  4. Choose the relevant options and complete the webhook registration process.

Webhook payload:

  1. For every webhook event, following payload will be triggered.
  2. This payload is a JSON object with two keys, "notifications" and "requests", each internally containing a JSON object.
  3. The notifications object gives details about the action which was performed on the document and the requests object contains the details about the document for which the webhook was called.


  1. {
  2. "notifications": 
  3. {
  4. "performed_by_email": "<email address of the person performing the operation. ",
  5. "performed_by_name": "<user who performed this operation",
  6. "performed_at": <time value in java current time in mills format>,
  7. "reason": "Reason stated for the operation-applicable if any",
  8. "activity": "<small description of activity performed",
  9. "operation_type": "RequestSubmitted | RequestViewed | RequestSigningSuccess | RequestCompleted | RequestRejected | RequestRecalled | RequestForwarded | RequestExpired",
  10. "action_id": "<sign action id",
  11. "ip_address": "<ip address captured during this operation>"
  12. },
  13. "requests": 
  14. {
  15. "request_status": "<status of the document>",
  16. "request_name": "<name of the sign request>",
  17. "request_id": "<long value - primary key of the signature request",
  18. "document_ids": 
  19. [
  20. {
  21. "document_name": "<name of the document inside signature request",
  22. "document_id": "<long value - of the document contained inside request"
  23. }
  24. ]
  25. }
  26. }
Sample payload:
  1. {
  2. "notifications": 
  3. {
  4. "performed_by_email": "testuser@zoho.com",
  5. "performed_at": 1555062604837,
  6. "reason": "reason given if any",
  7. "activity": "Document has been signed",
  8. "operation_type": "RequestSigningSuccess",
  9. "action_id": "1000000000090",
  10. "performed_by_name": "test user",
  11. "ip_address": ""
  12. },
  13. "requests": 
  14. {
  15. "request_name": "NDA Document",
  16. "request_id": "1000000000000",
  17. "request_type_id": "10000000011",
  18. "document_ids": 
  19. [
  20. {
  21. "document_name": "CommonNDA.pdf",
  22. "document_id": "100000000000050"
  23. }
  24. ]
  25. }
  26. }
  1. operation_type attribute under notification JSON object can have one of the following pre-defined constants with which actions are triggered. This attribute plays an important role in identifying the type of event that took place.
Operation Types
Reason for triggering
When a document is submitted for signature.
When a submitted document is viewed.
When one of the signers successfully completes the signing process.
When all the assigned signers or approvers completes the signing or approval process.
When a submitted signature request is rejected.
When a submitted signature request is recalled by the sender.
When a submitted request is forwarded to another person by the assigned signer.
When a submitted document expires the allocated signing time.

  1. For signer-related actions, such as RequestViewed, RequestSigningSuccess, RequestRejected, and RequestForwarded, there will be 'action_id' of the signer present inside the 'notifications' json. 
  2. All other data that comes as part of notification payload are not standard data attributes and may be removed anytime in future. Users are advised to use documented attributes alone.

    Zoho CRM Training Programs

    Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

    Zoho CRM Training
      Redefine the way you work
      with Zoho Workplace

        Zoho DataPrep Personalized Demo

        If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

        Zoho CRM Training

          Create, share, and deliver

          beautiful slides from anywhere.

          Get Started Now

            Zoho Sign now offers specialized one-on-one training for both administrators and developers.

            BOOK A SESSION

                                    You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.

                                        Manage your brands on social media

                                          Zoho Desk Resources

                                          • Desk Community Learning Series

                                          • Digest

                                          • Functions

                                          • Meetups

                                          • Kbase

                                          • Resources

                                          • Glossary

                                          • Desk Marketplace

                                          • MVP Corner

                                          • Word of the Day

                                            Zoho Marketing Automation

                                              Zoho Sheet Resources


                                                  Zoho Forms Resources

                                                    Secure your business
                                                    communication with Zoho Mail

                                                    Mail on the move with
                                                    Zoho Mail mobile application

                                                      Stay on top of your schedule
                                                      at all times

                                                      Carry your calendar with you
                                                      Anytime, anywhere

                                                            Zoho Sign Resources

                                                              Sign, Paperless!

                                                              Sign and send business documents on the go!

                                                              Get Started Now

                                                                      Zoho TeamInbox Resources

                                                                              Zoho DataPrep Resources

                                                                                Zoho DataPrep Demo

                                                                                Get a personalized demo or POC

                                                                                REGISTER NOW

                                                                                  Design. Discuss. Deliver.

                                                                                  Create visually engaging stories with Zoho Show.

                                                                                  Get Started Now

                                                                                                      • Related Articles

                                                                                                      • Webhooks Security

                                                                                                        Zoho Sign offers you an option to secure your webhooks by using HMAC-SHA 256 (Hash-Based Message Authentication Codes with SHA 256), an industry standard hashing mechanism to ensure the authenticity and integrity of the webhook is intact. Securing a ...
                                                                                                      • Accessing Zoho Sign from Zoho PeoplePlus

                                                                                                        This page lists the actions supported via Zoho Sign in the Zoho PeoplePlus bundle. This includes both the actions supported via native integrations between Zoho Sign and the products in the bundle and the actions accessible directly from the Zoho ...
                                                                                                      • Zoho Sign credits

                                                                                                        What are Zoho Sign credits and what are they used for? Zoho Sign credits are a prepaid add-on that requires an additional purchase on top of the subscription cost of the Zoho Sign general licensing plans. Zoho Sign credits are consumed when users in ...
                                                                                                      • Zoho Sign integration with Pipedrive

                                                                                                        Available only in Enterprise edition Zoho Sign now integrates with Pipedrive, customer relationship management software that helps small and medium businesses to manage their sales pipeline. This integration can help sales team to directly send ...
                                                                                                      • Creating a Zoho Sign account

                                                                                                        If you are a new Zoho user, you have to create a Zoho account to access Zoho Sign and Zoho's other services. Creating a Zoho Account Go to Zoho Homepage and click Sign up to create an account with your email or using your Google, LinkedIn, or ...
                                                                                                        Wherever you are is as good as
                                                                                                        your workplace



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


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


                                                                                                          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.

                                                                                                            Zoho Show Resources