Actions API - Webhooks APIs - Part 2

Actions API - Webhooks APIs - Part 2


Hello all!! 
Welcome back to the follow-up Kaizen post of Kaizen #219: Actions API - Webhooks APIs - Part 1.

In the previous week, we covered how to configure a basic Webhook and how to include Headers, Body, and URL Parameters using both the POST Webhook API and the Zoho CRM UI.
In this part, we will take one of the previously discussed examples and demonstrate how to achieve the same result using the GET, PUT, and DELETE Webhook APIs.
We will also walk through how to associate a Webhook with a Workflow, how to perform real-time testing by creating a record, and how the external application receives the response sent from Zoho CRM via the Webhook.

Retrieving a Webhook using the GET - Webhook API

Request URL: {{api-domain}}/crm/v8/settings/automation/webhooks/5725767000008778002
 - Note: You can retrieve all available Webhooks using "{{api-domain}}/crm/v8/settings/automation/webhooks" request.

Request Method: GET
Sample Response:

{
    "webhooks": [
        {
            "headers": {
                "module_parameters": [
                    {
                        "name": "Lead_Email",
                        "value": "${!Leads.Email}"
                    },
                    {
                        "name": "Annual_Revenue",
                        "value": "${!Leads.Annual_Revenue}"
                    },
                    {
                        "name": "Profit_Score",
                        "value": "${!Leads.Profit_Score}"
                    }
                ],
                "custom_parameters": [
                    {
                        "name": "source",
                        "value": "zylker-crm"
                    },
                    {
                        "name": "version",
                        "value": "v1"
                    }
                ]
            },
            "created_time": "2025-11-30T07:18:50-08:00",
            "lock_status": {
                "locked": false
            },
            "editable": true,
            "module": {
                "api_name": "Leads",
                "id": "5725767000000002175"
            },
            "related_module": null,
            "url_parameters": null,
            "deletable": true,
            "description": "Send leads with Profit Score > 80 to validation system.",
            "source": "crm",
            "body": {
                "format": null,
                "type": "none"
            },
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "feature_type": "workflow",
            "http_method": "POST",
            "modified_time": "2025-11-30T07:18:50-08:00",
            "associated": false,
            "name": "Push High Score Leads",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "id": "5725767000008778002",
            "date_time_format": null,
            "authentication": {
                "connection_name": null,
                "type": "general"
            }
        }
    ]
}


Updating the Webhook using the PUT - Webhook API

Request URL: {{api-domain}}/crm/v8/settings/automation/webhooks
Request Method: PUT

Input JSON:

{
    "webhooks": [
        {
            "headers": {
                "module_parameters": [
                    {
                        "name": "Lead_Email",
                        "value": "${!Leads.Email}"
                    },
                    {
                        "name": "Profit_Score",
                        "value": "${!Leads.Profit_Score}"
                    },
                    {
                        "name": "Lead_Industry", // adding a new field
                        "value": "${!Leads.Industry}"
                    }
                ],
                "custom_parameters": [
                    {
                        "name": "source",
                        "value": "zylker-crm"
                    },
                    {
                        "name": "version",
                        "value": "v1"
                    }
                ]
            },
            "url": "https://webhook.site/abcd1234-5678-90ef-ghij-123456789axx", // changing external application's URL
            "http_method": "POST"
        }
    ]
}


Note: 
  1. You cannot update the module field. The rest of the fields can be updated using the PUT - Webhook API.
  2. Exclude a field, header section, URL parameter section, body section from the request if you want to remove its configuration from your webhook.
  3. http_method is mandatory for the Update call.
  4. To change the external URL, the http_method key is mandatory.

Deleting the Webhook using the DELETE - Webhook API

Request URL: {{api-domain}}/crm/v8/settings/automation/webhooks
Request Method: DELETE

Sample Response:
{
    "webhooks": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "5725767000008778002"
            },
            "message": "Webhook is deleted",
            "status": "success"
        }
    ]
}
Note: You cannot delete a Webhook if it is associated with any automation feature like Workflow and Blueprint.

Associating a Webhook to a Workflow Rule using the Workflow API

Create a Workflow:
You can use the Configure Workflow Rule API to create a workflow.

Associate the Field Update:
You can associate a Webhook action with the workflow by using the unique ID of the Webhook.

Retrieve the Webhook ID using the Get Webhooks API.

Request URL:  {{api-domain}}/crm/v8/settings/automation/workflow_rules
Request Method: POST
Sample Input:

{
    "workflow_rules": [
        {
          .
          .
          .
            "execute_when": {
                "details": {
                    "trigger_module": {
                        "api_name": "Leads",
                        "id": "5725767000000002175"
                    }
                },
                "type": "create_or_edit"
            },
            "module": {
                "api_name": "Leads",
                "id": "5725767000000002175"
            },
            "name": "High Profit Leads",
            "conditions": [
                {
                    "instant_actions": {
                        "actions": [
                            {
                                "name": "Push High Score Leads",
                                "id": "5725767000008775001", //associating the created Webhooks with the Workflow
                                "type": "webhooks"
                            }
                        ]
                    },
                    "scheduled_actions": null,
                    "criteria_details": {
                       .
                         .
                        .
                        "criteria": {
                            "comparator": "greater_equal",
                            "field": {
                                "api_name": "Profit_Score",
                                "id": "5725767000008570336"
                            },
                            "type": "value",
                            "value": "80"
                        }
                    }
                 
                }
            ],
            .
            .
            .
        }
    ]
}


For more details on Workflow Rules using APIs, refer to Kaizen #213 - Workflow APIs - Part 1, Part 2, and Part 3.

Sample Webhook:


Creating a high Profit Score lead using the Create Records API

To test our webhook end-to-end, we will create a high Profit Score lead using the Create Records API. When this lead meets the workflow condition, the webhook fires, allowing us to observe the exact payload sent to the external system.

Request URL:  {{api-domain}}/crm/v8/settings/automation/workflow_rules
Request Method: POST
Input JSON
{
    "data": [
        {
            "Owner": {
                "name": "Tim",
                "id": "5725767000000411001",
                "email": "tim@zoho.com"
            },
            "Annual_Revenue": 2000000,
            "Full_Name": "Patricia Boyle",
            "Layout": {
                "name": "Standard",
                "id": "5725767000000091055"
            },
            "Company": "Info Technology",
            "Email": "infotech@mail.com",
            "Industry": "Large Enterprise",
            "First_Name": "Patricia",
            "Profit_Score": 90,
            "Profit_Category": "High Profit",
            "Last_Name": "Boyle"
        }
    ]
}
Real response in Zylker’s external validation system:

After setting up the webhook and linking it to a workflow, we added a test lead that matched our condition. The external app received the webhook instantly, just the way we configured. This shows how easily Zoho CRM can push data to any system in real time. This real-time flow ensures clean, validated, enriched leads reach the Sales team faster, improving response time and conversion rates.

We hope this post helps you understand how to use Webhooks through the Zoho CRM Actions API - Webhooks API.

Try it out, and let us know your experience in the comments section or reach out to us at support@zohocrm.com.
Stay tuned for more insights in our upcoming Kaizen posts!

Cheers!



 


    • Recent Topics

    • Add a way to connect Log360 Cloud logs with Zoho analytics

      Hi, Several month ago Log360 Cloud was added to zoho one - and this is great. But as far as I see there is no prebuilt way to connect Zoho analytics to the logs we have in Log360 Cloud. Please add a prebuilt connection like we have for so many other zoho

    • Use arbitrary images in deluge

      I am sending emails from my deluge code and I would like to be able to include a few images in the email template. While I know that I could put the on a website somewhere and link to them in the HTML, that is not what I want due to email client security

    • Funcionalidades y configuration ZohoDesk

      Creo que no estoy sacando el provecho adecuado a la application quisiera solicitar una capacitación al respecto

    • How to call Functions and perform Write Operations using Page Scripts?

      Hi everyone, How to call a function from a Zoho Creator application within a Page Script, also how to perform write operations (adding or updating records) using page scripts?

    • Connecting Airwallex in Zoho Books

      I have a question. I’m trying to connect our Airwallex account to Zoho Books, but the integration does not seem to work. Could you please guide me on how to properly connect Airwallex? I need to see the expenses also, since it only shows the profits now

    • Questions Regarding Helpdesk & SalesIQ Customization and Email Setup

      Hello, I hope you’re doing well. I have a few questions regarding Helpdesk and SalesIQ: Can the emails sent to customers via helpdesk tickets be fully customized — including signature, subject line, and other elements? Also, is it possible to send these

    • Button Duplication when emails forwarded or replied

      When I create a new email template in campaigns and send it out it looks fine to all the users, however if that email is then on forwarded or replied to then all buttons within the email duplicate.  See below The one on the left is the original one.

    • Workdrive backup and default storage selection

      Hi community, I have been informed by Zoho that workdrive will be the default storage mechanism for crm and projects. These 2 Apps seem to have different design on how they interact with workdrive for storage. 1. Crm: seems to have files saves at the

    • Cliq iOS can't see shared screen

      Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? Regards

    • Ask the Experts 27: Onboarding and managing support reps

      Hello everyone, We are back with our Ask the Experts (ATE) series for 2026. This year, we bring experts to help you address customer support challenges using Zoho Desk. For our first ATE, we are getting into the human side of customer support. "Every

    • CRM x WorkDrive: File storage for new CRM signups is now powered by WorkDrive

      Availability Editions: All DCs: All Release plan: Released for new signups in all DCs. It will be enabled for existing users in a phased manner in the upcoming months. Help documentation: Documents in Zoho CRM Manage folders in Documents tab Manage files

    • Assign emails to lead

      I have some contacts who refers leads but there is no away to manually assign emails to lead.   

    • sync two zoho crm

      Hello everyone. Is it possible to sync 2 zoho crm? what would be the easiest way? I am thinking of Flow. I have a Custom Module that I would like to share with my client. We both use zoho crm. Regards.

    • Built-in Date Functions in Zoho Analytics Query Tables

      I have a doubt about whether Zoho Analytics Query Tables provide built-in functions for start date, end date, and the current month

    • Introducing Rollup summary in Zoho CRM

      ------------------------------------------Moderated on 5th July'23---------------------------------------------- Rollup summary is now available for all organizations in all the DCs. Hello All, We hope you're well! We're here with an exciting update that

    • Enhancements for Currencies in Zoho CRM: Automatic exchange rate updates, options to update record exchange rates, and more

      The multi-currency feature helps you track currencies region-wise. This can apply to Sales, CTC, or any other currency-related data. You can record amounts in a customer’s local currency, while the CRM automatically converts them to your home currency

    • Marketer's Space: Why your open rates suddenly drop to zero?

      Hey everyone—welcome back to another post in Marketer's Space! If you regularly track the performance of your campaigns, open rates are probably one of the first numbers you check after sending an email. So it can be quite alarming when a campaign suddenly

    • CRM x WorkDrive: We're rolling out the WorkDrive-powered file storage experience for existing users

      Release plan: Gradual rollout to customers without file storage add-ons, in this order: 1. Standalone CRM 2. CRM Plus and Zoho One DCs: All | Editions: All Available now for: - Standalone CRM accounts in Free and Standard editions without file storage

    • Bulk upload images and specifications to products

      Hi, Many users have asked this over the years and I am also asking the same. Is there any way in which we can bulk upload product (variant) images and product specifications. The current way to upload/select image for every variant is too cumbersome.

    • Introducing Workqueue: your all-in-one view to manage daily work

      Hello all, We’re excited to introduce a major productivity boost to your CRM experience: Workqueue, a dynamic, all-in-one workspace that brings every important sales activity, approval, and follow-up right to your fingertips. What is Workqueue? Sales

    • Import Quote from CRM into document in Writer?

      Hi, I created a quote for a proposal in the Zoho CRM and was wondering if there is a way to embed the quote into a document in Zoho Writer so I can make our sales proposals look a little nicer. Is that possible?

    • Private email threads

      When sending a Private email or receiving a response once the email thread has been marked as 'Private'- is there a way to trigger the system to "restart the clock"? I am finding that when someone responds to a 'Private' thread that it is opening the

    • SLA Notification

      Team members have been receiving this notification and feel as though it is as random. Explanation on this notification is appreciated! Also, is there a way to disable this notification?

    • I'd like to Import Contacts for an SMS Campaign, but they don't have email addresses.

      I've got a contact list of about 4000 contacts. Some only have mobile phone and not email. Can I still import the contacts?

    • Incoming email replies not automatically associating with Deals/Opportunities - Is this possible in Zoho CRM?

      Hello Zoho Community, I'm running a travel agency (B2B and B2C) and we've been struggling with what seems like a basic functionality that we cannot get to work properly. Our use case: We send emails to suppliers (hotels, transportation companies) and

    • Transaction Rule Matching

      Q1. Is there a method to have the Transaction Rules applied across multiple Bank Accounts? Q2. To match "contains" text in Transaction Rules, is a wildcard or regular expression required? Is it case sensitive? Would searching for "issue" in the following

    • Newby Questions - Vendors, Customers, and Income vs. Other Income Clarifications

      Q1. For Deposits, there does not seem to be an option for "Income". "Other Income" is an option however. What is the process to add the option to assign a deposit to type "Income"? Q2. In many cases Vendors and Customer are the same. Vendors may purchase

    • Newby Questions

      Q1. The top bar of Zoho Books has a "Search in Banking (/) " field. What is the proper use of this text box? - Searching for Amazon for example has no results but there are transactions. - Is the search case sensitive? - Are regular expressions allowed?

    • Duplicate Leads Notification Help!

      Hello! I have several web forms that have a duplicate lead notification that are being sent to the creator of the web form. I understand how to change the form entry notification, but I am specifically looking to change the recipient of the "Duplicate Lead" notification. Any help you can offer is greatly appreciated! TIA, ~ Jenn

    • Bulk Associate Tasks/Task Lists to Milestones (Similar to Issues)

      Hello Zoho Projects Team, We hope you are doing well. We would like to request an enhancement regarding Milestone management for Tasks in Zoho Projects. Current Behavior: In the Issues module, it is possible to select multiple issues and easily associate

    • How to see Statement Details Shown in Unclassified Transactions in All Transactions?

      All, The list of Unclassified Transactions show the Statement Details and Descriptions. What is the method to see that column in the All Transactions list? -Thanks!

    • Zoho CRM - Feature Request - Analytics Components Group By Week Alternative Formats

      On the Zoho CRM Analytics Components, please consider adding an option to allow group by week format to be changed to other formats such as Week Commencing or Week Ending dates, rather than the current Week Number. This would provide improved usability

    • Is Zoho Sites still actively being developed?

      Hello, Is Zoho Sites still actively being developed as part of the Zoho ecosystem? I noticed that the What's New page (https://www.zoho.com/sites/whats-new.html) does not show any updates since Q1 2025. We were considering migrating our website from Squarespace

    • Adding new data to the sheet with most recent data being added to top row.

      I am using a form that I built from within sheets.  When the form is submitted, is it possible to have the data entered in (for example) row 2 (since row 1 is the heading) instead of being added into the next available row which should be hundreds of

    • Duplicate Leads Concerns with Round Robin and Lead Approval Process

      It is great to have the Duplicate Lead Approval Process, there are a few issues with the process that I would greatly appreciate taken consideration in enhancing. It appears that A Lead comes in Lead owner assigned by the Round Robin Check for Duplicate,

    • need a packing list feature

      In our business, goods listed on an invoice are packed in separate boxes and shipped off. for e.g. an invoice may have 10 items. each item could then be packed in different boxes depending on qty of each item. this packing list is as important as the invoice for purposes of shipping documents.  Request you to add this feature asap.

    • Editing Item Group to add Image

      I did not have the image of the product when the Item Group was created. Now I have the product image, and would like to associate/add to the Item Group. However the Item Group Edit functionality does not show/allow adding/changing image. Please hel

    • Zoho CRM Queries Now Support Databases and Cloud Data Sources

      Hello everyone! We're thrilled to announce a major enhancement to the Queries feature in Zoho CRM! Queries now support a broader range of external data sources, allowing you to fetch live data and combine it with CRM records, all using a unified query

    • Map: Output None

      Hi, Checking if you help me inspect this block The code below triggers during Successful form Submission from another Form. // rec_a = formA[ID!=0]; rec_b = formB[ID!=0]; ListA = List(); //subformA for each recA in rec_a.ItemSubform { for each recB in

    • Re: Application Architecture in Zoho Creator — A Platform-Specific Deep Dive

      A recent community post on application architecture made some excellent points about planning architecture early in Zoho Creator projects. The core message is right — Creator applications have a habit of growing organically into maintenance nightmares,

    • Next Page