Get webhook execution failure records

GET/settings/automation/webhook_failures

Use it in a workflow

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

Request

Query parameters

webhook_idstring

Specify the unique identifier of the webhook whose failure records to retrieve. Refer to the [Get Webhooks](webhooks.yaml#$.paths./settings/automation/webhooks.get) resource for valid values. When omitted, failure records for all webhooks are returned.

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.

fromstring (date)

Specify the start date (inclusive) for the query window in YYYY-MM-DD format, evaluated in the organization's time zone. For webhook_failures, defaults to 30 days before **to**; earlier dates are clamped to that 30-day window. For usage_reports, defaults to 30 days before **to**. Future dates return 400 INVALID_DATA.

tostring (date)

Specify the end date (inclusive) for the query window in YYYY-MM-DD format, evaluated in the organization's time zone. Defaults to the current date at 23:59:59 when omitted. Must be on or after the **from** date. Future dates are rejected.

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

Response

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

webhook_failuresarray<object>

Represents the list of webhook execution failure detail objects.

webhookobject2 fields

Represents a lightweight reference to a webhook, containing its unique identifier and display name. Used in failure log records.

entity_detailsobject3 fields

Represents the details of the CRM record whose automation event triggered a failed webhook execution.

failure_timestring

Represents the ISO 8601 timestamp of when the webhook execution failed.

failure_reasonstring

Represents the reason for the webhook execution failure, such as page_notfound.

idstring

Represents the unique identifier of the failure record.

workflow_ruleobject2 fields

Represents a reference to the workflow rule that triggered a webhook execution.

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

{
  "webhook_failures": [
    {
      "webhook": {
        "name": "string",
        "id": "string"
      },
      "entity_details": {
        "module": {
          "api_name": "string",
          "id": "string"
        },
        "name": "string",
        "id": "string"
      },
      "failure_time": "string",
      "failure_reason": "string",
      "id": "string",
      "workflow_rule": {
        "name": "string",
        "id": "string"
      }
    }
  ],
  "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?