Webhooks facilitates communication with third-party applications by sending instant web notifications every time an event occurs in Zoho Invoice. With Webhooks, you can configure both HTTP & HTTPS URLs and associate them in workflow rules to automate the entire notification process.
For example, you can associate your Zoho Invoice account with a SMS provider with a webhook to thank your customer by sending a message automatically if the total amount paid exceeds $1000.
For general information about webhooks, please refer to webhooks.org
To set up a webhook, navigate to > More Settings > Automation > Webhooks and click on + New Webhook.
|Name||Give a unique name for the webhook.|
|Module||Select the module for which you wish to create a webhook.|
|Description||Give a small description of the webhook.|
|URL to notify||Enter the URL of the external service provider’s API. For example, if you want Zoho Invoice to add or change data in Zoho CRM, the URL would be https://crm.zoho.com/crm.|
|Method||Specify the function you want to call at the external service:
POST: Requests that data centrist be considered as new.
PUT: Requests that data sent should be considered as a modified version of the one already present.
DELETE: Requests that the data must be deleted.
|Custom Parameters||You can add custom parameters. in the webhook such as Auth Token, Security Token, API Key etc. based on which the URL will be appended. Enter the required parameter under Parameter Name and the corresponding value under Parameter Value. If you wish to add multiple parameters, select + Add Custom Parameters.|
|Entity Parameters||Append All Parameters- Select this option to send all parameters from Zoho Invoice to the external service.
Append Selected Parameters- Select this option to send selected parameters from Zoho Invoice to the external service.
|URL Preview||The URL generated for this web hook will be displayed here.|
There are two options available while communicating data with a third party application, namely,
- Append All Parameters- Select this option to communicate all data as and when it is created.
- Append Selected Parameters- Select this option to transfer only the data you want to send. If you choose this option, additional fields appear.
|Parameter Name||Enter the name of the parameter that you wish to append and select the module in the corresponding box.|
|Parameter Value||Select the desired parameter from the drop down.|
Note: You can add multiple entity parameters by selecting +Add Entity Parameter. You can add a maximum of 10 entity parameters.
User Defined Parameters
If you wish to add user defined parameters while accessing an external service, select the box Add User Defined Parameters.
|Parameter Name||Enter the name of the parameter which you wish to update.|
|Value Description||Select a module of Zoho Invoice from the first drop down and select the corresponding parameter from the drop down of the adjacent box. This will generate the placeholder string for that parameter.
You can enter the custom code in different formats. For example, if you wish to send a JSON or XML string with parameter values from an estimate, you can use the user defined parameters and placeholders format.
If you wish to include the placeholder in the string, select Insert Placeholder.
Click on Save to create a webhook. You can now select one of the many webhooks created to connect with an external service provider when a workflow rule is triggered.
Delete a webhook:
To delete a webhook, hover the cursor next to a field update on the list and click on the Trash icon.
To filer the Webhooks list, follow these steps:
- Navigate to > More Settings > Automation > Webhooks.
- Under Module, select a module from the drop down for which the webhook been created.
Based on your selection, the corresponding webhook will be displayed as a list.
- You can create only 1 web hook for each workflow rule.
- A maximum of 500 webhooks can be triggered per day.
Also Read About: