Authenticate Emails with SPF, DKIM, and SenderID Auto forward your emails to Vtiger Automate Outgoing Emails in Email Settings Managing User Profiles Automation - Approvals Automation - Assignment Rules Set up Multi-path Workflows Creating a Scheduled Workflow Automation - Workflow Scheduler Workflows in Vtiger CRM Webforms in Vtiger CRM Set up a Workflow Action to Create Event Set up a Workflow Action to Create Records Set up a Workflow Action to Create Task Set up a Workflow Action to Invoke Custom Function Set up a Workflow Action to Create an SMS Task Set up a Workflow Action to Send Mails Workflow Action to Update Fields Automation - Expressions Workflow Configuration - Business Hours Configuration - Company Details Configuration - Consents Configuration - Customer Portal Maps in Vtiger CRM Configuration - Usage Details Configuring Encrypted Data Fields in Vtiger CRM Configure Picklist Dependencies Considerations for Deactivating Vtiger Users Control Fields and Record Displays using Configuration Editor Create Reminders for Records and Inbox Create a field of a Grid type Dealing with Currencies and Taxes Enable Desktop Notifications on Chrome Web Browsers Vtiger CRM Add-ons IMAP Configuration - 2-way sync between Vtiger and IMAP providers Setting up Autopay & Payment Gateways Inventory - Tax Management Inventory - Terms and Conditions Login to Vtiger on SSO SAML using ADFS Mailroom Functionality for Different Scenarios Manage Multiple Currencies Marketing and Sales - Deal to Project Mapping Marketing and Sales - Lead Conversion Data Mapping Marketing and Sales - Profile Scoring Module Management - Labels Editor Module Management - Module Numbering Configure My Preferences Feature My Preferences - Calendar Settings Tags in Vtiger My Preferences - Notification Preferences SAML Support in Vtiger CRM Vtiger Mailroom Settings - Configure Module Settings Settings - Create Dynamic Fields and Layouts Module Management - Creating a Relationship Between Modules Settings - Customize Records and Fields for your Business Settings - How to set email autoresponder to Webform submission? Settings - Left Menu Settings - Manage Global Picklists in Vtiger Settings - Set up your Support Team Settings - Start Up Page Settings - Working with Picklist Values Module Management - Module Builder Support - SLA Policies Troubleshooting Login Issues Add-Edit Unsubscribe Links in your Email Template User Management - Authentication User Management - Encrypted Field Access Logs User Management - Groups User Management - Login History User Management - Profiles User Management - Roles User Management - Settings Log User Management - Sharing Rules User Management - Users User Management - Vtiger Support Access Vtiger Buzz - Chrome Extension for Notifications Vtiger Implementation wizard Vtiger Language Support Configuring Websense Trackers Websense - Widgets Module Management - Modules Module Management - Module Layouts & Fields Generate and Manage Third-party App Passwords in Yahoo Configuring App Passwords for Gmail Outgoing Server and Yahoo Mail Configuration - Storage Guard Customizing your Self-Service Portal Theme Using CSS Styles Automation - SMS Reply Actions Adding Hidden Fields to a Webform Configuring Dependent Fields and Blocks for Modules Auto forward Emails from Microsoft Office 365 Adding Custom Module Login Page Customization Settings - Personalize Module Layouts Duplicate Prevention in Modules Formula Fields Creating Custom Filters Adding a local DNS Entry

Feature Availability

Vtiger Editions: One Growth | One Professional | One Enterprise
Click here to view the availability of Workflow Actions in different Vtiger CRM editions.

Introduction

A webhook is a user-defined callback that is triggered by an event in the source application. When the event happens, the system sends data to a specified URL, allowing other systems to take immediate action. This helps automate workflows and keep records in sync across different platforms.
To learn more about webhooks, click here.

Why Choose Webhooks?

You can use webhooks to notify your software application of changes that occur in Vtiger.
Business scenarios: 

• When a deal is closed, a webhook can send customer details to the accounting software to automatically create an invoice
• When a new lead is added, a webhook can send their details to your email tool, allowing you to automatically add them to a campaign list.

How do Webhooks work?

Webhooks work by sending real-time data from one application to another when a specific event happens.
Here’s a simple breakdown of the process:

• Event Occurs: An event occurs in your system, such as a new purchase or user registration.
• Webhook is triggered: This event automatically triggers the webhook.
• Data is sent: The webhook sends the event data (usually in JSON format) to a predefined URL.
• The receiving system processes the data: The receiving system receives the data and automatically performs the required task, such as updating records or sending an email.

Webhooks support all workflow-enabled modules. You can send Webhook API requests in an array format. In the Webhook Workflows, you must map this with a dot.
Note: Dot notation is supported only for PUT and POST requests.
 

Key Features of Webhooks

Here are some features that make webhooks a helpful tool for seamless data exchange between systems.

• Webhooks send data (usually in JSON or XML format) that includes all relevant details about the event.
• Webhooks are typically one-way — from sender to receiver — making them simple and fast for sending notifications or updates.
• Ideal for connecting with third-party apps, CRMs, payment systems, notification tools, and more.
• Webhook logs help track requests, responses, errors, and payloads for easier troubleshooting.
• Only active when triggered, which reduces the load on both systems and conserves bandwidth

Benefits of using Webhooks

The benefits of using webhooks are

• Real-Time Data Delivery: Provides real-time updates as soon as an event occurs, ensuring that your systems stay synchronized without delays.
• Automation of Tasks: Automate workflows such as sending notifications, updating records, or triggering actions, thereby reducing manual intervention.
• Easy Integration: Allows seamless integration between different applications without complex configurations, as long as they support HTTP callbacks.
• Monitoring and Debugging: Logs help track events, responses, and any errors, which is valuable for monitoring performance and troubleshooting issues.

In this article, you will learn about:

• Setting up Webhook action
• Capturing webhook response
• Webhook Logs
• Different Log statuses
• Troubleshooting issues in workflows

Key Terminology

 

Setting up Webhook Action

You can automate the process of sending data to external applications by using webhooks in workflows. This allows your CRM to communicate with other systems in real-time whenever specific actions occur, such as creating a lead, updating a deal, or closing a ticket. By setting up webhooks within workflows, you can trigger external actions like sending notifications, updating records in another system, or syncing data without manual effort. 
Let us learn how to set up webhooks by considering Freshbooks as the third-party accounting software. 
Follow these steps to set up a webhook action:

1. Log in to the CRM.
2. Click the User Menu in the top right corner of the screen.
3. Click the Settings button. 
4. Look for the Automation section.
5. Select Workflows. The Workflows window opens.
6. Click the +New Workflow button.
7. Select Standard.
8. Enter or select the following information:
   1. Basic information
      1. Workflow Name: Specify the name of the workflow.
      2. Target Module: Specify the module on which the workflow must execute, such as Deals, Contacts, Products, etc.
      3. Status: Specify the workflow status as Active or Inactive. The workflow does not execute when the status is set to Inactive
      4. Description: Provide a brief description of what the workflow is used for, the actions it performs, etc.
   2. Workflow trigger. Specify when the workflow must trigger by choosing an option from the following two fields:
      1. Trigger Workflow On:
         1. Record creation: Choose this option if you want the workflow to trigger when a record is created in the Target Module (mentioned in the previous section).
         2. Record updation (includes creation): Choose this option if you want the workflow to trigger when a record is updated or created in the Target Module (mentioned in the previous section).
         3. Time Interval: Choose this option if you want the workflow to trigger at a frequent time interval.
         4. Frequency: Specify the frequency at which the workflow must trigger. To learn more about this option, click here.
      2. Recurrence: This option is shown when you select Record updation in the previous section.
         1. Only first-time conditions are met: Triggers the workflow if the specified conditions are true. Once executed, the workflow will not trigger on the same record again. However, it will trigger other records in the selected module.
         2. Every time conditions are met: Triggers the workflow on a record every time the specified conditions are true.
   3. Entry criteria. 
      1. You can specify multiple conditions using the +Add condition button. There are two types of conditions.
      2. All conditions: It is based on the logical AND operation. Workflow executes when all the conditions are met.
      3. Any condition: It is based on the logical OR operation. Workflow executes when at least one condition is met.
      4. Note: There is an AND operation between All conditions and Any condition. The conditions mentioned under both All conditions and Any condition are applied in the entry criteria.
   4. ​Actions
      1. Set up the webhook action by clicking the Add Action drop-down.
      2. Select Webhook.
      3. Enter the Action Title and Description.
      4. Specify the URL of the third-party application under URL to Notify. 
      5. This supports three methods: 
         1. GET - Retrieves a record from the third-party.
         2. POST - Creates a record in the third-party.
         3. PUT - Updates a record in the third-party.
         4. In our example, the data from the closed deal is sent to Freshbooks to create an invoice. Example URL: POST - http://accounting_software_example_url.com
9. Select the format in which you want to notify under Content Type. Vtiger supports four content types: XML, JSON, JSONARRAY, and FORM.
10. Choose the Authorization Type:
    1. Choose Basic Authentication if the third-party service requires a username and password.
    2. Select No Authentication if authentication isn't required.
11. Provide the entity Parameters of the third party and the values you want to push. 
    1. You must enter the following information for the example considered: Accounting Software ID, Account ID, Public ID, Authtoken, Fields present in the third-party system, and their respective values in Vtiger.
12. Click Save.

Limitations

• You can add up to three Webhooks per workflow.
• You must add all the fields present in the third party as parameters during the configuration.
• Authentication fields and Public ID are the mandatory parameters.
• You can use a Workflow Webhook to send current module data along with related module information.
  • For example, you can send Contact information and the related Deal record information in one request. So if one contact has five deals, then you can send the Contact’s information, like first name, last name, and mobile number, as well as the related Deal information, such as Deal name, Deal ID, amount, etc.
• You can select five related modules for a webhook.
  • You need to enable the Related Modules checkbox on the Webhook Action page and then use the Add Related Module button to select a module from the drop-down. The drop-down displays all the related modules you have selected in the Workflow.

Capturing Webhook Response

Vtiger CRM enables you to capture webhook responses directly into CRM records, allowing seamless integration with external applications and real-time data syncing.

Follow these steps to capture the webhook response:

1. Log in to the CRM.
2. Click the User Menu in the top right corner of the screen.
3. Click the Settings button.
4. Look for the Automation section.
5. Select Workflows. The Workflows page opens.
6. Click +New Workflow.
7. Select Standard.
8. Specify the basic information, workflow trigger, and entry criteria. To learn about them, click here.
9. Set up the webhook action by clicking the Add Action drop-down.
10. Select Webhook.
11. Enter the Action Title and Description.
12. Specify the URL of the third-party application under URL to Notify.
    1. This supports three methods: 
       1. GET - Retrieves a record from the third-party.
       2. POST - Creates a record in the third-party.
       3. PUT - Updates a record in the third-party.
    2. In our example, the data from the closed deal is sent to Freshbooks to create an invoice.
    3. Example URL: POST - http://accounting_software_example_url.com
13. Select the format in which you want to notify under Content Type.
    1. Vtiger supports four content types: XML, JSON, JSONARRAY, and FORM.
14. Choose the Authorization Type:
    1. Choose Basic Authentication if the third-party service requires a username and password.
    2. Select No Authentication if authentication isn't required
15. Provide the entity Parameters of the third party and the values you want to push. 
    1. For the example considered, you must enter the following: Accounting Software ID, Account ID, Public ID, Authtoken, the Fields present in the third party, and their respective values in Vtiger.
16. Enable the Capture Response option to record the incoming response.
17. Select the appropriate response type based on the data you want to capture. This supports two methods:
    1. JSONPATH: To extract specific data from a JSON-formatted webhook response.
    2. XPATH: To extract specific data from an XML-formatted webhook response.
    3. Select the fields to capture under On Success and On Failure using JSONPath or XPath, depending on the response format.
18. Click Save.

You can view the captured webhook response in the Details section of the Webhook logs.

Viewing Webhook Logs

Vtiger records every activity triggered when the configured event occurs. The log tables help you track the data that you send to the third-party application.
Follow these steps to view webhook logs:

1. Log in to the CRM.
2. Click the User Menu in the top right corner of the screen.
3. Click the Settings button. 
4. Look for the Automation section.
5. Select Workflows.  
6. Open the workflow that has the webhook action configured.
7. Scroll down to the Actions section of the workflow.
8. Click the View Webhook log link shown beside the action.

Log Status

Webhook logs show the status of each request sent. Here’s what the different statuses mean.

• Queued: When the data is yet to be dispatched.
• Retry: When the webhook request fails initially, the system attempts to resend it automatically.
• Dispatched: When the data has been dispatched to the third party. 
• Success: When the data has been delivered to the third party.
• Failed: When the webhook fails to send the data.

Note:

• The web notifier service handles retries. There can be three retries: 
  • 1 hour for the first retry
  • 2 hours for the second retry
  • 4 hours for the third retry
• Every retry is logged in the webhook log.
• The record owner and all active admins are notified via email when a webhook fails.

Troubleshooting Tips

Below are common errors you might encounter while setting up webhook workflow actions:

• Webhook is not triggering
  • Double-check the workflow conditions and make sure they match the trigger scenario.
  • Ensure that the record is saved after changes for the workflow to execute.
  • Confirm that the webhook action is added under the correct condition group.
• Data not received correctly at the target application
  • Check the data structure sent by Vtiger and compare it with the third-party API’s expected format.
  • Use field mapping in the webhook action to include all required fields.
• No response or empty response from webhook
  • Verify that the webhook URL is correct and publicly accessible.
  • Check if the third-party service is active and accepting requests.
• Webhook logs show the status as Failed
  • Check the status code and response in the webhook logs.
  • Make sure the endpoint is reachable and responsive.
  • Fix any typos in the URL.

References

• Creating a Workflow
• Creating a Scheduled Workflow
• Set up Multipath Workflows

User Management - Sharing Rules Set up a Workflow Action to Create an SMS Task Configuration - Usage Details Managing Customer Cases API Designer in Vtiger CRM