Get Action Failures - Webhooks

Purpose

To retrieve detailed information about webhook execution failures in your Zoho CRM organization.

Endpoints

  • GET /settings/automation/webhook_failures

Request Details

Request URL

{api-domain}/crm/{version}/settings/automation/webhook_failures

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.automation_actions.ALL
(or)
ZohoCRM.settings.automation_actions.READ

Parameters
  • webhook_idstring, optional

    The unique ID of the webhook whose failure details you want to retrieve.

  • modulestring, optional

    To filter webhook failures by module.

  • fromstring, optional

    The start date in YYYY-MM-DD format, from which webhook failure details are to be fetched.. 

  • tostring, optional

    The end date in YYYY-MM-DD format, up to which failure records are to be retrieved.

  • pageinteger, optional

    The page number for pagination. Default value is 1.

  • per_pageinteger, optional

    Number of records per page. The default and maximum value is 200.
     

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/webhook_failures"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET

Note:

  • If the from and to parameters are not specified, the API returns webhook failures from the last 30 days by default.
  • When using date filters, the maximum allowed span between from and to dates is 90 days

Response JSON

The response body will contain the webhook_failures array. Each object within this array represents a webhook failure record, and will include the following:

  • webhookJSON object

    Details of the webhook that failed to execute. Includes the webhook’s name and unique ID.

  • entity_detailsJSON object

    Contains the details about the record that triggered the webhook failure.

    • namestring

      The name of the record that caused the webhook to trigger.

    • idstring

      The unique ID of the record for which the webhook execution failed.

    • moduleJSON object

      Contains the api_name and id of the module to which the record belongs.

  • failure_timestring

    The ISO 8601–formatted timestamp when the webhook execution failed.

  • failure_reasonstring

    The reason for the webhook failure. Possible values are page_notfound, unauthorized, timeout.

  • idstring

    The unique ID for the specific webhook failure entry.

  • workflow_ruleJSON object

    Contains the name and id of the workflow rule that triggered the webhook.

Possible Errors

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: This API supports only the GET method. Retry the request using the GET method.

  • INVALID_DATAHTTP 400

    The value provided to the param is Invalid
    Resolution: Specify valid values for all parameters.

  • INVALID_MODULEHTTP 400

    The value provided to the param is Invalid
    Resolution: Specify valid value for the module parameter.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have the required OAUTH SCOPE. Create a new token with valid scope. Refer to the Scope section for more details.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section for more details.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

Sample Response

Copied{
    "webhook_failures": [
        {
            "webhook": {
                "name": "Premium Lead Alert",
                "id": "4876876000016390771"
            },
            "entity_details": {
                "module": {
                    "api_name": "Leads",
                    "id": "4876876000000002175"
                },
                "name": "Freelancer.com",
                "id": "4876876000016474049"
            },
            "failure_time": "2025-10-21T17:08:07+05:30",
            "failure_reason": "page_notfound",
            "id": "4876876000016474075",
            "workflow_rule": {
                "name": "WF-C",
                "id": "4876876000016390881"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}