Get webhooks

GET/settings/automation/webhooks

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Get webhooks action (under Webhooks).
Fill in the fields below, then reference the result from later steps as {{getWebhooks.response.data}}.

Request

Query parameters

modulestring

Specify the API name of the parent CRM module to filter webhooks. When omitted, webhooks across all modules are returned. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.

pageinteger (int32)

Specify the page number for paginated results. Defaults to 1 when omitted. Use together with per_page to navigate large result sets.

per_pageinteger (int32)

Specify the number of records to return per page. Default and maximum is **200**.

sort_bystring

Specify the field used to sort the webhook list. Currently only Modified_Time is accepted. Possible values: **Modified_Time** - Sort by the last modified timestamp.

One ofModified_Time

sort_orderstring

Specify the sort direction for list results. Defaults to desc when omitted. Possible values: **asc** - Ascending order. **desc** - Descending order.

One ofascdesc

feature_typestring

Specify the automation feature type to filter webhooks. When omitted, webhooks of all feature types are returned. Possible values: **workflow** - Workflow Rule. **approval_process** - Approval Process. **blueprint_transition** - Blueprint transition. **blueprint_state** - Blueprint state. **assignment_rules** - Assignment Rules. **kiosk** - Kiosk feature. **commandcenter_service** - CommandCenter service.

One ofworkflowapproval_processblueprint_transitionblueprint_stateassignment_ruleskioskcommandcenter_service

related_modulestring

Specify the API name of a child or dependent module linked to the parent module (for example, Notes or Attachments). When omitted, webhooks across all related modules are returned.

filtersstring

Specify the JSON filter expression to narrow webhook results by name. The object must include field (with api_name), comparator, and value keys. The only supported comparator is contains, which performs a case-insensitive partial match on the webhook name.

Response

Returns 200 with an object. Read it in later steps with {{getWebhooks.response.data.<field>}}.

webhooksarray<object>

Represents the list of webhook summary objects returned by the list operation.

created_timestring

Represents the ISO 8601 timestamp of when the webhook was created.

headersobject2 fields

Represents the HTTP headers configuration for the outgoing webhook request. Supports module merge-field parameters and custom static parameters. The host header name is reserved and cannot be used.

lock_statusobject2 fields

Represents the lock status of the webhook. Locked webhooks cannot be edited or deleted.

editableboolean

Indicates whether the current user can edit this webhook. Returns false for marketplace and extension-created webhooks. Possible values: **true** - The webhook can be edited. **false** - The webhook cannot be edited.

moduleobjectrequired2 fields

Represents the CRM module reference identifying the parent module associated with a webhook.

related_moduleobject | null2 fields

Represents a reference to a related CRM module linked to the parent module of a webhook. Returns null when no related module is configured. Required when feature_type is kiosk.

url_parametersobject | null3 fields

Represents the URL query parameters appended to the webhook request URL. Applicable only when http_method is GET or DELETE. Returns null when http_method is POST or PUT.

deletableboolean

Indicates whether the current user can delete this webhook. Returns false for marketplace and extension-created webhooks. Possible values: **true** - The webhook can be deleted. **false** - The webhook cannot be deleted.

descriptionstring | null

Represents the optional user-provided description of the webhook purpose. Returns null when no description has been set.

sourcestring | null

Represents the origin of the webhook. Returns null for legacy webhooks. Possible values: **user** - Created by a CRM user. **crm** - Created by the CRM system. **extension** - Created by a Marketplace extension.

bodyobject4 fields

Represents the request body configuration for the outgoing webhook request. For type **form_data**, provide form_data_content with module_parameters and custom_parameters; format may be null. For type **raw**, supply raw_data_content and a format value of JSON, XML, Text, or HTML. For type **none**, the body carries no content and format may be null.

created_byobject2 fields

Represents the CRM user who created the webhook.

urlstringrequired

Represents the destination URL that Zoho CRM sends the webhook request to when triggered.

feature_typestringrequired

Represents the automation feature type this webhook belongs to. Possible values: **workflow** - Workflow Rule. **approval_process** - Approval Process. **blueprint** - Blueprint. **kiosk** - Kiosk feature. **commandcenter_service** - CommandCenter service.

http_methodstringrequired

Represents the HTTP method used when the webhook fires. Possible values: **GET** - Sends a GET request to the webhook URL. **POST** - Sends a POST request to the webhook URL. **PUT** - Sends a PUT request to the webhook URL. **DELETE** - Sends a DELETE request to the webhook URL.

modified_timestring

Represents the ISO 8601 timestamp of when the webhook was last modified.

associatedboolean

Indicates whether this webhook is currently associated with at least one active Workflow Rule, Approval Process, or Blueprint. Possible values: **true** - The webhook is associated with at least one automation rule. **false** - The webhook is not associated with any automation rule.

namestringrequired

Represents the display name of the webhook.

modified_byobject2 fields

Represents the CRM user who last modified the webhook.

idstring

Represents the unique identifier of the webhook.

date_time_formatobject | null3 fields

Represents the date and time formatting configuration applied to date or datetime merge-field values in webhook request payloads. Applicable only when a date or datetime merge-field is used in headers, url_parameters, or body. Returns null when no date or datetime merge-fields are present.

authenticationobject2 fields

Represents the authentication configuration for the webhook endpoint. Use type **general** for endpoints that do not require credentials. Use type **connection** with a valid connection_name for endpoints that require authenticated access via a pre-configured Zoho connection.

infoobject

Represents the pagination metadata returned with list responses.

max_limitinteger (int32)

Represents the maximum number of records allowed per page for this resource.

per_pageinteger (int32)

Represents the number of records returned per page in the paginated response.

countinteger (int32)

Represents the total number of webhooks returned in the current page.

pageinteger (int32)

Represents the current page number in the paginated response.

more_recordsboolean

Indicates whether additional pages of results are available. Possible values: **true** - More records exist beyond the current page. **false** - The current page contains the last records.

json

{
  "webhooks": [
    {
      "module": {
        "api_name": "string",
        "id": "string"
      },
      "url": "string",
      "feature_type": "string",
      "http_method": "string",
      "name": "string",
      "created_time": "string",
      "headers": {
        "custom_parameters": null,
        "module_parameters": null
      },
      "lock_status": {
        "locked": false,
        "message": "string"
      },
      "editable": false,
      "related_module": {
        "api_name": "string",
        "id": "string"
      },
      "url_parameters": {
        "custom_parameters": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "module_parameters": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "user_defined_parameters": {
          "name": "string",
          "value": "string"
        }
      },
      "deletable": false
    }
  ],
  "info": {
    "max_limit": 0,
    "per_page": 0,
    "count": 0,
    "page": 0,
    "more_records": false
  }
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?