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