Webhooks - Zoho People

Webhooks Automation - Zoho People

What is a webhook?

A webhook in Zoho People is a method for automating real-time data transfer or notifications from Zoho People to third-party applications based on specific events that occur in Zoho People. Webhooks enable instant communication by sending notifications to a specified URL whenever a user performs an action in Zoho People. This automation facilitates seamless and efficient integration between Zoho People and other third-party applications.

Webhooks are user-defined HTTP callbacks, functioning as automated event notifications sent via HTTP POST. They notify a specified URL by delivering a message whenever predefined events take place.

How Webhooks works in Zoho People

  1. Create a Webhook for a form in a service and associate it with a new or existing Workflow.
  2. Whenever a Workflow trigger event occurs, the Webhook is triggered, sending automated notifications from Zoho People to third party applications.

Benefits of Webhooks

  1. Flexible and customizable.
  2. Sends instant notifications to third party applications.
  3. Users can integrate with their own custom applications or any third party applications.
  4. Real-time data synchronization.
  5. A complete webhooks list, webhook failures, and successes are provided.

Types of Webhooks

  1. Webhooks List: Using Zoho People webhooks, you can communicate with the third party applications by sending instant notifications every time when a user performs an action on the organizational account data.
  2. Failure Webhooks: The failure webhooks are listed on this page along with the details such as webhook name, form name, associated record, latest invoke time, redo an action and the response message. You can also filter the webhooks using the following options such as forms, the name of the webhooks and the duration period.
  3. Successful Webhooks: The successful webhooks are listed on this page along with the details such as webhook name, form name, associated record, latest invoke time and the response message. You can also able to filter the webhooks using the following options such as forms, the name of the webhook and the duration period.

API

Zoho People provides APIs (Application Programming Interface) for integrating HR modules with third-party applications. With Zoho People API, you can extract employees data and form data in XML or JSON format and develop new applications or integrate with your existing business applications. As Zoho People API is independent of programming languages, you can develop applications in any programming language (Java, .Net, C, C++, PHP, etc.) .

To learn more, click here.

Fields in Webhooks

Field Name Description Data Type Maximum Limit
Name Specify name of the webhook Text Alphanumeric(50)
Description Add a description for the webhook Text 250 characters
URL to Notify Specify the API URL of the third-party application or Zoho application (eg: Zoho People, Zoho Creator) URL 250 characters
Method Select type of API method - POST or GET. POST is the default selected method Radio Button -
Module Choose the 'Form' from which the data is to be communicated to the third-party application Picklist -
Append Entity Parameters Specify the Parameter Name and corresponding Parameter Value. This is the request parameters sent while triggering the webhook notification to third-party application. String 3000 characters
Append Custom Parameters Specify the Zoho People Parameter Name and corresponding Value for the webhook. This is also the request parameters sent while triggering the webhook. The name and the value are as configured. This key/value pair is mainly used to send the Auth tokens, security tokens, etc. String -
Preview URL Preview the complete webhook URL to be notified to the third-party application. Text Read-only
 

Set up Webhook in Zoho People

Webhook is simple and easy to configure. You just need to configure HTTP URLs and associate them with a workflow rule to automate the workflow process. Follow the steps below to configure webhooks for a service.

  1. From your homepage, navigate to Settings > Select a Service > Automation > Actions > Webhooks.
  2. Click Add Webhook.
  3. In the Webhook set up page configure as follows.
  4. Select the form in the service where the Webhook bust be trigged upon change event.
  5. Enter a Webhook name.
  6. Specify the third party URL to notify.
  7. Enter the description (purpose of the webhook.
  8. Selecta API method as either POST or GET based on the requirement.
  9. Specify the necessary URL Query Parameters:
    Info
    Specify the parameter name and the corresponding parameter value. You can add only 10 entity fields as parameters specify the parameter in user defined format. Eg: XML, JSON etc., specify the custom parameter name and parameter value. You can add only 5 custom parameters.

  1. If necessary add  a custom HTTP header to securely transmit authentication tokens, security tokens, API keys, or other credentials within the request header.


  2. Preview URL and if necessary click Refresh URL to update.


  3. Click Save.
    Webhook will be saved and available to be tagged to a workflow.

Map a Webhook to a Workflow

Create a workflow with trigger events based on which webhooks must be triggered, and associate the Webhook with the Workflow.

To map a Webhook to a Workflow:
  1. From your home page, go to Settings > Select a Service > Workflows > Add Workflow.
  2. Provide all the required details, Learn more to configure Workflow.
  3. Under Actions, click Webhook and click the (+) add icon to add a new Webhook to the workflow or you can select the existing Webhook which are created for the form.
  4. Click Add.
    A workflow is created, and based on the trigger events, the webhook is triggered, sending a notification to the third-party application.

Use Case

Change Employee Status in Exit Form via Webhook

Let's consider a scenario - An employee is resigning his job and you want to change the status as Resigned in the Employee form. Before Webhook was introduced, you need to manually update changes twice in the Employee form as well as in the Exit form. But now, you can automatically POST notification in the Exit form by configuring Webhook using API. Please follow the steps below to configure webhook for this scenario.

  1. From your homepage, navigate to Settings > Select a Service > Automation > Actions > Webhooks.
  2. Click Add Webhook.
  3. In the Webhook set up page configure as follows.
  4. Select the Employee form from the list
  5. Enter a Webhook name.
  6. Enter a description
  7. Select API method type as POST
  8. Enter the URL query parameters as follows
    Quote
    For the User Defined format: Specify the Parameter Name xmlData and the Value Description as shown below:
    <Request>
    <Record>
    <field name="Employee_ID">${ZOHO_LINK_ID}</field>
    <field name="Interviewer">${Reporting_To}</field>
    <field name="Separation_date">${Exit_Date}</field>
    </Record>
    </Request>
    Info
    In the above XML string, the tag field represents the fields in Zoho People, the name represents the label name of the field and the value tag represents data to be pushed.
  9. Specify Custom Parameters: "authtoken" in the Parameter Name and the authtoken key in Parameter Value.
    Info
    To use the API, you will require Zoho People authentication token from your Zoho People account. For Zoho People API Guide, Click here.
  10. Click Save.
Info
Map this Webhook to a Workflow and define the trigger events.

      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          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







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit

                              Intake FormsLegal
                              Mobile App
                              Form DesignerHR
                              Mobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsFormstack alternativeEncrypted Forms

                              Wufoo alternativeSecure Forms

                              WCAG



                                        Create. Review. Publish.

                                        Write, edit, collaborate on, and publish documents to different content management platforms.

                                        Get Started Now







                                                          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


                                                                • Desk Community Learning Series


                                                                • Digest


                                                                • Functions


                                                                • Meetups


                                                                • Kbase


                                                                • Resources


                                                                • Glossary


                                                                • Desk Marketplace


                                                                • MVP Corner


                                                                • Word of the Day


                                                                • Ask the Experts


                                                                  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 Demo

                                                                                                    Get a personalized demo or POC

                                                                                                    REGISTER NOW


                                                                                                      Design. Discuss. Deliver.

                                                                                                      Create visually engaging stories with Zoho Show.

                                                                                                      Get Started Now









                                                                                                                          • Related Articles

                                                                                                                          • Zoho People 5.0 Administrator Guide

                                                                                                                            What is Zoho People 5.0? Zoho People is a comprehensive cloud-based HR software that aims to streamline HR processes, enhance employee engagement, and improve workforce productivity. With this refreshing new version, Zoho People further aims to ...
                                                                                                                          • Zoho People 5.0 - What has changed?

                                                                                                                            Changes in Home tab and Self Service Zoho People 4.0 Zoho People 5.0 Landing page is Home > Dashboard Self Service page: New Landing page is Home > My Space > Overview (Replacement for Self service in Zoho People 4.0 with additional features). ...
                                                                                                                          • Workflow Automation - Zoho People

                                                                                                                            What is a Workflow in Zoho People? Automate your HR process and operation through Zoho People Workflow. Creating workflows for a services helps you to eliminate most of the manual HR tasks, boost efficiency, and save your time. Benefits of Workflow ...
                                                                                                                          • Custom Functions Automation - Zoho People

                                                                                                                            What is a Custom Function? Custom functions in Zoho People help simplify complex, multi-step actions through program scripts that you can write and execute. Custom functions helps in workflow automation where procedural logic is required, which ...
                                                                                                                          • Performance - Automation

                                                                                                                            Automation in the Performance module allows you to enable or disable system notifications, configure workflows and their actions, set up email, letter, and mail merge templates for the service, and view workflow logs. Notifications To enable system ...
                                                                                                                            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