Scenarios

1. After closing a potential in your CRM, you can push the customer information to any third-party accounting software and automatically generate an Invoice for the Customer.
2. You can add subscribers to the mailing list in Email Marketing software (e.g. MailChimp) based on leads or contacts collected from your Website using your CRM's Web forms.
3. You can trigger SMS reminders to field sales reps about customer meetings, demos and other events.
4. You can generate an estimate in your accounting software as soon as the opportunity stage is changed from Prospecting to Price Quote.
   

Target Audience

1. CRM Users with Manage Workflow permissions
2. Programmers with REST API skills
   

 Availability

Profile Permission Required: Users with the Manage Workflow permissions in can access this feature.

List of Fields in Webhook

 

Set Up Webhooks

1. Create a webhook.
2. Associate webhook to a workflow rule.
3. Test webhook integration.
   

1. Click Edit for the application that you want to edit.
2. Click Automate > Workflow > Webhooks.
3. In the Webhooks page, click the Configure Webhook.
4. In the Configure Webhook page, specify all necessary parameters.
5. Click Save.
   

1. Click Setup > Automate > Workflow > Rules.
2. In the Workflow Rules page, click the Create Rule.
3. In the New Rule page, specify workflow rule parameters.
4. Under Instant Actions, select webhook.
   
5. Select the webhook you want to associate.
6. Click Associate.
   

1. Add test data in your CRM according to your workflow rule criteria.
2. In your application, check for the data received from your CRM via webhook notification.
3. If there is an error or data mismatch, modify your webhook settings in your CRM.
4. Continue this test until you obtain the required data from CRM to your Application.
   

Important Notes

1. You can associate up to 6 (1 Instant Action and 5 Time-Based Actions) webhooks per workflow rule.
2. You can transfer data for a maximum of 10 CRM fields from your CRM to third-party applications using webhook.
3. You cannot retrieve data from other Apps to your CRM using webhooks.
4. You must update the API ticket regularly according to limits in third-party applications.
5. You will not receive any email notification, if the Webhook integration stopped functioning due to any issue in third-party API.
6. If there is any failure in the process, Webhook will send a notification first, and your CRM system will send a second notification after 15 min. Thereafter, the system will not send any Webhook notifications for that particular workflow trigger.
7. If you exceed the maximum count per day, the system will not send remaining Webhook notifications to third-party applications and will notify the failure to Administrator.
8. In the URL to Notify field, if you want to specify a port number, please note that only 80 or 443 port numbers are supported.
9. Data will be sent in the following standard format for Date and Date Time fields to third-party applications:
1. Date: yyyy-MM-dd
2. Date Time: yyyy-MM-dd hh:mm
   

Business Scenario 1

Purpose

Pre-requisite

1. Account in Zoho Creator Application
2. Permission to access Zoho API
3. Familiarity with Zoho Creator
   

Procedure

1. Create the Sales Commission App in Zoho Creator (Refer Zoho Creator Tutorial on Creating Apps )
2. Configure webhook
3. Set up Workflow Rule 
4. Test your webhook integration 
   

Step 1: Create Sales Commissions App in Zoho Creator

1. Sales Rep
2. Potential Name
3. Customer Name
4. Opportunity Amount
5. Type of Business: New Business or Existing Business
6. Closing Date
7. Sales Commission

Step 2: Configure Webhook

1. Potential Name
2. Closing Date
3. Type
4. Record Owner
5. Amount
   

Note:

1. In the above XML string, name represents the field in Zoho Creator App and the value for data is to be pushed from CRM.
2. <applicaton name> is the name of the application that contains the form in Zoho Creator. Get your application name from the Application Settings tab of Zoho Creator.
3. <form name> is the name of the form where you edit records in Zoho Creator. Get your form name from the Form Settings of your Zoho Creator account.
4. Ensure that the date format in the Creator app is in yyyy-MM-dd format. You can change the date format from the Application Settings of your Zoho Creator account.
   

Custom Parameters:

Note

To retrieve data from other apps to Zoho Creator, you must specify the username and authtoken of Zoho API. To generate Zoho API information, refer to the Online Help

 Step 3: Set up Workflow Rule

1. Set up workflow criteria as:
   
1. Type is New Business
2. Stage is Closed Won
   
2. Select the webhook as an instant action.
3. Save workflow rule. 
   
   

Workflow Rule Criteria

Associate Webhook to Workflow Rule

Step 4: Test your Integration

Refer Error Codes

HTTP Status Codes

1. 400 Bad Request - Often missing a required parameter.
2. 401 Unauthorized - No valid Auth Token provided.
3. 402 Request Failed - Parameters were valid but request failed.
4. 404 Not Found - The requested item doesn't exist.
5. 500, 502, 503, 504 Server errors - Something went wrong on third-party application.
6. Error Code 1 - Temporarily not able to connect to the API server. You need to check API server logs, firewalls settings for our requests sent from CRM.
   

Custom Errors

1. Internal process failure - When the webhook is not executed due to errors in processing the webhook.
2. Day limit reached - When the company reached the maximum limit for the day.