Tool ID:
zoho_crm_webhooks_get_webhooksRun this action
Use the TypeScript SDK for a single call. Putctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_webhooks_get_webhooks',
{
"module": "Leads",
"page": 1,
"per_page": 200
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute zoho_crm_webhooks_get_webhooks --input '{
"module": "Leads",
"page": 1,
"per_page": 200
}' --json
Example response
The SDK exposes this shape atresult.toolResponse.raw. Values below are representative.
{
"data": {
"webhooks": [
{
"module": {
"api_name": "Example",
"id": "id_123"
},
"url": "https://example.com",
"feature_type": "example",
"http_method": "example",
"name": "Example"
}
],
"info": {
"max_limit": 123,
"per_page": 123,
"count": 123
}
}
}
deepline tools get zoho_crm_webhooks_get_webhooks --json for the latest machine-readable contract.
Input reference
Retrieve all available webhooks configured in your Zoho CRM account.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
payload.module | "Leads" | No | — | Represents the parent module that the webhook monitors Allowed: Leads. |
payload.page | 1 | No | — | To get the list of webhooks from the respective pages. The default value is 1. Note that you cannot use this param with the “page_token” param. Allowed: 1. Format: int32. |
payload.per_page | 200 | No | — | Specify how many webhooks to return per page. The default and the maximum possible value is 200. Allowed: 200. Format: int32. |
payload.sort_by | "Modified_Time" | No | — | To sort the webhooks based on the Modified_Time field. Allowed: Modified_Time. |
payload.sort_order | "desc" | No | — | To sort the available list of webhooks in either ascending or descending order, based on the value of sort_by parameter. Allowed: desc. |
payload.feature_type | "workflow" | No | — | o filter webhooks by their automation feature type. Possible values: workflow , assignmentrules , connectedworkflow Allowed: workflow. |
payload.related_module | "Notes" | No | — | To filter webhooks triggered by a child or dependent module linked to a parent module. For example, the webhook will be triggered whenever a note (child) is created under a lead (Parent). Allowed: Notes. |
payload.filters | "{ \"field\": { \"api_name\": \"{{value}}\" }" | "\"comparator\": \"equals\"" | "\"value\": \"{{value}}\" }" | No | — | This parameter allows you to filter the webhooks available in your organization by their name. Allowed: { "field": { "api_name": "{{value}}" }, "comparator": "equals", "value": "{{value}}" }. |
Output reference
Standard tool result payload.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
result.data | object | Yes | — | Successful response structure for fetching a list of webhooks, including webhook data and pagination information. |
result.data.webhooks | array | No | — | Field: webhooks Maximum items: 3. |
result.data.webhooks[].created_time | string | No | — | Field: created_time Maximum length: 255. |
result.data.webhooks[].headers | object | No | — | Encapsulates headers for webhook requests including both module-specific and custom parameters, required for sending extra information. |
result.data.webhooks[].headers.custom_parameters | array | No | — | These are static values that never change. They are always sent with the webhook call. Maximum items: 2. |
result.data.webhooks[].headers.custom_parameters[].name | string | No | — | Specify a name to the custom header. Maximum length: 255. |
result.data.webhooks[].headers.custom_parameters[].value | string | No | — | Specify a value to the custom header. Maximum length: 255. |
result.data.webhooks[].headers.module_parameters | array | Yes | — | Headers let you send extra information along with the webhook request. For example, API keys, authentication tokens, or custom values that the external application needs. (Required) Maximum items: 3. |
result.data.webhooks[].headers.module_parameters[].name | string | No | — | Specify a unique header name. Please note that if you choose Headers, you must add at least one module parameter with a value. If you do not add it, the system will show an error when you try to save the webhook. Maximum length: 255. |
result.data.webhooks[].headers.module_parameters[].value | string | No | — | Specify a value of the module header, specified using the merge field format. Example, ${!Leads.Email}. Maximum length: 255. |
result.data.webhooks[].lock_status | object | No | — | Represents the lock status property of an automation assignment rule, indicating whether the rule is currently locked. |
result.data.webhooks[].lock_status.locked | boolean | No | — | Field: locked |
result.data.webhooks[].lock_status.message | string | No | — | Field: message Maximum length: 255. |
result.data.webhooks[].editable | boolean | No | — | Field: editable |
result.data.webhooks[].module | object | Yes | — | Provides details of a module within an automation assignment rule, including API name and module ID. |
result.data.webhooks[].module.api_name | string | No | — | Field: api_name Maximum length: 255. |
result.data.webhooks[].module.id | string | No | — | Field: id Maximum length: 255. |
result.data.webhooks[].related_module | object | null | No | — | Nested schema for related_module |
result.data.webhooks[].related_module.api_name | string | No | — | Field: api_name Maximum length: 255. |
result.data.webhooks[].related_module.id | string | No | — | Field: id Maximum length: 255. |
result.data.webhooks[].url_parameters | record | No | — | Nested schema for url_parameters |
result.data.webhooks[].deletable | boolean | No | — | Field: deletable |
result.data.webhooks[].description | string | null | No | — | Field: description Maximum length: 255. |
result.data.webhooks[].source | string | null | No | — | Field: source Maximum length: 255. |
result.data.webhooks[].body | object | No | — | Defines the structure of the request body for a webhook, including data format and content to be sent during POST and PUT operations. |
result.data.webhooks[].body.format | "JSON" | "XML" | "HTML" | "Text" | No | — | Specify the format of the body (Required) Allowed: JSON, XML, HTML, Text. Maximum length: 4. |
result.data.webhooks[].body.raw_data_content | string | null | No | — | Use this when you want to send plain text, JSON, HTML, or XML content directly. Maximum length: 500. |
result.data.webhooks[].body.type | "form_data" | "raw" | Yes | — | Specify the body Type (Required) Allowed: form_data, raw. Maximum length: 255. |
result.data.webhooks[].body.form_data_content | object | No | — | Nested schema for form_data_content |
result.data.webhooks[].body.form_data_content.module_parameters | array | No | — | Field: module_parameters Maximum items: 1. |
result.data.webhooks[].body.form_data_content.module_parameters[].name | string | No | — | Specify a unique header name. Please note that if you choose Headers, you must add at least one module parameter with a value. If you do not add it, the system will show an error when you try to save the webhook. Maximum length: 255. |
result.data.webhooks[].body.form_data_content.module_parameters[].value | string | No | — | Specify a value of the module header, specified using the merge field format. Example, ${!Leads.Email}. Maximum length: 255. |
result.data.webhooks[].body.form_data_content.user_defined_parameter | object | No | — | Nested schema for user_defined_parameter |
result.data.webhooks[].body.form_data_content.user_defined_parameter.name | string | No | — | Field: name Maximum length: 255. |
result.data.webhooks[].body.form_data_content.user_defined_parameter.value | string | No | — | Field: value Maximum length: 255. |
result.data.webhooks[].body.form_data_content.custom_parameters | array | No | — | Field: custom_parameters Maximum items: 2. |
result.data.webhooks[].body.form_data_content.custom_parameters[].name | string | No | — | Specify a name to the custom header. Maximum length: 255. |
result.data.webhooks[].body.form_data_content.custom_parameters[].value | string | No | — | Specify a value to the custom header. Maximum length: 255. |
result.data.webhooks[].created_by | object | No | — | Information about the creator of a specific automation assignment rule, including the creator’s name and ID. |
result.data.webhooks[].created_by.name | string | No | — | Field: name Maximum length: 255. |
result.data.webhooks[].created_by.id | string | No | — | Field: id Maximum length: 255. |
result.data.webhooks[].url | string | Yes | — | Field: url Maximum length: 255. |
result.data.webhooks[].feature_type | string | Yes | — | Field: feature_type Maximum length: 255. |
result.data.webhooks[].http_method | string | Yes | — | Field: http_method Maximum length: 255. |
result.data.webhooks[].modified_time | string | No | — | Field: modified_time Maximum length: 255. |
result.data.webhooks[].associated | boolean | No | — | Field: associated |
result.data.webhooks[].name | string | Yes | — | Field: name Maximum length: 255. |
result.data.webhooks[].modified_by | object | No | — | Details about the person who last modified a specific automation assignment rule, including their name and ID. |
result.data.webhooks[].modified_by.name | string | No | — | Field: name Maximum length: 255. |
result.data.webhooks[].modified_by.id | string | No | — | Field: id Maximum length: 255. |
This output schema is too large to embed without slowing the page. Get the complete live contract with
deepline tools get zoho_crm_webhooks_get_webhooks --json.Deepline cost
- Pricing model:
fixed(per call). - Estimated Deepline credits:
0per pricing unit. - Provider-native pricing may still exist outside Deepline credit billing.