What is Webhooks?

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
Description
Sent
Triggers when documents are sent for signatures. 
Viewed
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.
Declined
Triggers when documents are declined by one of the recipients
Reassigned
Triggers when documents are reassigned by one of the recipients to be signed or approved by another person.
Expires
Triggers when documents are sent for signatures and the approval expires.
Recalled
Triggers when documents are sent for signatures or approval are recalled by the sender.

Prerequisites:

  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 admin of a Zoho Sign account can register a webhook by clicking Settings from the left navigation pane, then choosing API Settings.
  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. Choose the relevant options and complete the webhook registration process.

  1. The Test URL option sends a sample payload to the specified callback URL. This is used to verify the configuration and connectivity.

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.

Structure:

  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": "192.168.100.100"
  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. }
Note:
  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
RequestSubmitted
When a document is submitted for signature.
RequestViewed
When a submitted document is viewed.
RequestSigningSuccess
When one of the signers successfully completes the signing process.
RequestCompleted
When all the assigned signers or approvers completes the signing or approval process.
RequestRejected
When a submitted signature request is rejected.
RequestRecalled
When a submitted signature request is recalled by the sender.
RequestForwarded
When a submitted request is forwarded to another person by the assigned signer.
RequestExpired
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





                        Still can't find what you're looking for?

                        Write to us:  support@zohoforms.com



                              




                            

                              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 SalesIQ Resources



                                                        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 best practices

                                                                                            As a technical user, you use webhooks to set up or integrate applications and get real-time updates whenever an event or action occurs. The admin of a Zoho Sign account can configure a webhook and choose the events that will trigger it. The callbacks ...
                                                                                          • How to use Zoho CRM functions as callbacks, using Webhooks in ZohoSign?

                                                                                            This can be done as follows: Visit Zoho CRM and click the Settings icon at the top-right corner. Click Functions under the Developer Space. Click the New Function button. Specify the Function Name and Display Name, select Standalone from the category ...
                                                                                          Wherever you are is as good as
                                                                                          your workplace

                                                                                            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.



                                                                                              Zoho Show Resources