Submit a request Sign In
  • Logout
    Home  >   Articles   >  Automation - Workflow Action - Webhook
    Articles in this section
    Authenticate Emails with SPF, DKIM, and SenderID Auto forward your emails to Vtiger Automate Outgoing Emails in Email Settings Managing User Profiles Automation - Approvals Setting up User Roles Automation - Assignment Rules Set up Multi-path Workflows Creating a Scheduled Workflow Automation - Scheduler Creating a Workflow 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 Set up a Workflow Action to Update Fields Automation - Workflows - Vtiger Expressions 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 My Preferences 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 Adding Hidden Fields to a Webform Auto forward Emails from Microsoft Office 365 Adding Custom Module Configuration - Storage Guard Customizing your Self-Service Portal Theme Using CSS Styles Login Page Customization Creating App-specific Password for Gmail Outgoing Server Module Management - Module Layouts & Fields Settings - Personalize Module Layouts Module Management - Modules Automation - SMS Reply Actions Duplicate Prevention in Modules Configuring Dependent Fields and Blocks for Modules Formula Fields Creating Custom Filters Adding a local DNS Entry

    Automation - Workflow Action - Webhook

    Learn to alter or augment the behavior of a web page or a web application by using a webhook method.
    R
    Ruba
    27 Jun, 2024 - Updated 5 months ago
    Table of Contents

    Introduction

    A webhook is a user-defined HTTP callback that is triggered when an event occurs. A web application that implements webhooks will POST a message to a URL when a particular event occurs at the source site. 

    In simple terms, you can alter or augment the behavior of a web page or application's behavior by using custom callbacks with a webhook method.

    To learn more about webhooks, click here.

    Why Webhooks?

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

    Business scenarios: 

    • Closed a potential deal in Vtiger? Then use webhooks to push customer information to a third-party application (maybe an accounting software) to generate an invoice automatically.
    • You can push a newly created lead to a marketing list in your email marketing application.

    How do Webhooks work?

    Webhooks help communicate with third-party applications by sending instant web notifications. You can configure HTTP URLs and associate them with workflow rules to automate the notification process.

    Webhooks support all workflow-enabled modules. 

    You can send Webhook API requests in array format. In the Webhook Workflows, you must map this with a dot.

    Note: Dot notation is supported only for PUT and POST requests.

    Feature Availability


    Click here for Workflow Actions's availability for different Vtiger CRM editions.

    Setting up Webhook Action

    Let us learn how to set up webhooks by considering Freshbooks as the third-party accounting software. 

    Follow these steps to set up webhook action:

     
    1. Click the User Menu on the top right corner of the screen.
    2. Click the Settings button.
     
     
    1. Look for the Automation section.
    2. Select Workflows.
     
     
    1. Click the +New Workflow button.
    2. Select Standard.
     
     
    1. Specify the basic information, workflow trigger, and entry criteria. To learn about them, click here
     
     
    1. Set up the webhook action by clicking the Add Action drop-down.
    2. Select Webhook.
     
    1. Enter the Action Title and Description.
    2. Specify the URL of the third-party application under URL to Notify
      • This supports two methods: 
        1. POST - Creates a record in third-party
        2. PUT - Updates a record in third-party
      • In our example, the closed deal’s data is sent to Freshbooks to create an invoice
      • Example URL: POST - http://accounting_software_example_url.com
    3. Select the format in which you want to notify under Content Type
      • Vtiger supports four content types: XML, JSON, JSONARRAY, and FORM
    4. Choose the Authorization Type
      • Select the Basic Authentication radio button if the third party provides an authenticated service. Otherwise, choose No Authentication
      • If you choose Basic Authentication, then you must specify the username and password for the third-party account
    5. Provide the entity Parameters of the third party and the values you want to push. 
      • You must enter the following for the example considered: Accounting Software ID, Account ID, Public ID, Authtoken, Fields present in third-party and their respective values in Vtiger
    6. Click Save
     

    Note: 

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

    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. Click the User Menu on the top right corner of the screen.
    2. Click the Settings button.
     
     
    1. Look for the Automation section.
    2. Select Workflows.
     
     
    1. Open the workflow that has the webhook action configured.
     
     
    1. Scroll down to the Actions section of the workflow.
    2. Click the View Webhook log link shown beside the action.
     

    You will see the following details in a webhook log. You can filter the log according to different statuses.


    Different log statuses

    Here are the different log statuses:

    • Queued: When the data is yet to be dispatched
    • 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:

    1. 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
    2. Every retry is logged in the webhook log.
    3. The record owner and all active admins are notified via email when a webhook fails.
    Was this article helpful?
    3  out of  3  found this helpful.
    Related articles
    User Management - Sharing Rules Set up a Workflow Action to Create an SMS Task Configuration - Usage Details Managing Customer Cases
    Comments 0
    Be the first to comment
    Home
    Privacy Policy
    Terms of Service
    Security Center
    Policy & Legal Center
    Contact Us
    © Copyright 2023 Vtiger. All rights reserved.
    Powered by Vtiger