People Resources

Webhooks

Webhooks are user-defined HTTP callbacks. In other words, it is a simple event notification via HTTP post. It will notify a URL by POSTing a message when certain events happen. To be more clear, it communicates with the third party applications by sending instant notifications every time when a user performs an action in the Zoho People organizational account data. Webhooks are so useful, flexible and totally customizable.

Benefits of Webhooks

  • Flexible and Customizable
  • Sends instant notifications to third party applications
  • Users can integrate with their own custom applications or any third party applications
  • Real time data synchronization

What is API

Zoho People provides API (Application Programming Interface) for integrating HR modules with third-party applications. With the 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 the 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

Webhook configuration

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

  1. Log in as Administrator.
  2. Go to Setup at the top of the page.
  3. Click Webhooks under Automation.
  4. Click New Webhook.
  5. Name the Webhook.
  6. Add a description
  7. Specify the third party URL to notify.
  8. Select API method type: POST or GET.
  9. Select the form name or the module from the list
  10. Specify the parameter name and the corresponding parameter value. You can add only 10 entity fields as parameters <AND/OR> specify the parameter in user defined format. Eg: XML, JSON etc., <AND/OR> specify the custom parameter name and parameter value. You can add only 5 custom parameters.
  11. Click Save.

Example Scenario

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. Log in as Administrator.
    2. Go to Setup at the top of the page
    3. Click Webhooks under Automation
    4. Click New Webhook
    5. Name the Webhook.
    6. Add a description
    7. Specify the URL to notify.

      https://people.zoho.com/people/api/forms/P_Separation/insertRecord

    8. Select API method type: POST.
    9. Select the form name Employee from the list.
    10. For the User Defined format, specify the Parameter Name xmlDataand 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>
    11. Specify Custom Parameters: authtoken in the Parameter Name and the authtoken key in Parameter Value.
    12. Click Save.

      Note:

      • In the above XML string, the tag Field represent the fields in Zoho People, name represents the label name of the field and the value tag represents data to be pushed.

Custom Parameters

https://people.zoho.com/people/api/forms//insertRecord ?authtoken=XXXXXXXXXXXX&xmlData=<xmlData>

Note:

  • To use the API, you will require Zoho People authentication token from your Zoho People account. To generate Authtoken, click here.

Top