> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Webhooks Get Webhook Failures

> List failed Zoho CRM webhook calls, with the error, module and time. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List failed Zoho CRM webhook calls, with the error, module and time.

> [!NOTE]
>
> Tool ID: `zoho_crm_webhooks_get_webhook_failures`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_webhooks_get_webhook_failures',
  {
    "webhook_id": 12345678,
    "module": "Leads",
    "from": "2025-01-01"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_webhooks_get_webhook_failures --input '{
  "webhook_id": 12345678,
  "module": "Leads",
  "from": "2025-01-01"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "webhook_failures": [
      {
        "webhook": {
          "name": "Example",
          "id": "id_123"
        },
        "entity_details": {
          "module": {},
          "name": "Example",
          "id": "id_123"
        },
        "failure_time": "example"
      }
    ],
    "info": {
      "max_limit": 123,
      "per_page": 123,
      "count": 123
    }
  }
}
```

Use `deepline describe zoho_crm_webhooks_get_webhook_failures --json` for the latest machine-readable contract.

## Input reference

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

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.webhook_id` | `12345678` | No | — | The unique ID of the webhook whose failure details you want to retrieve. Allowed: `12345678`. Format: `int32`. |
| `payload.module` | `"Leads"` | No | — | Represents the parent module that the webhook monitors Allowed: `Leads`. |
| `payload.from` | `"2025-01-01"` | No | — | The start date in YYYY-MM-DD format, from which webhook failure details are to be fetched.. Allowed: `2025-01-01`. |
| `payload.to` | `"2025-01-23"` | No | — | The end date in YYYY-MM-DD format, up to which failure records are to be retrieved. Allowed: `2025-01-23`. |
| `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`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "To retrieve detailed information about webhook execution failures in your Zoho CRM organization.",
    "properties": {
      "webhook_id": {
        "type": "integer",
        "description": "The unique ID of the webhook whose failure details you want to retrieve.",
        "enum": [
          12345678
        ],
        "format": "int32"
      },
      "module": {
        "type": "string",
        "description": "Represents the parent module that the webhook monitors",
        "enum": [
          "Leads"
        ]
      },
      "from": {
        "type": "string",
        "description": "The start date in YYYY-MM-DD format, from which webhook failure details are to be fetched..",
        "enum": [
          "2025-01-01"
        ]
      },
      "to": {
        "type": "string",
        "description": "The end date in YYYY-MM-DD format, up to which failure records are to be retrieved.",
        "enum": [
          "2025-01-23"
        ]
      },
      "page": {
        "type": "integer",
        "description": "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.",
        "enum": [
          1
        ],
        "format": "int32"
      },
      "per_page": {
        "type": "integer",
        "description": "Specify how many webhooks to return per page. The default and the maximum possible value is 200.",
        "enum": [
          200
        ],
        "format": "int32"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Success response |
| `result.data.webhook_failures` | `array` | No | — | Field: webhook\_failures Maximum items: 1. |
| `result.data.webhook_failures[].webhook` | `object` | No | — | Nested schema for webhook |
| `result.data.webhook_failures[].webhook.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.webhook_failures[].webhook.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.webhook_failures[].entity_details` | `object` | No | — | Nested schema for entity\_details |
| `result.data.webhook_failures[].entity_details.module` | `object` | No | — | Provides details of a module within an automation assignment rule, including API name and module ID. |
| `result.data.webhook_failures[].entity_details.module.api_name` | `string` | No | — | Field: api\_name Maximum length: 255. |
| `result.data.webhook_failures[].entity_details.module.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.webhook_failures[].entity_details.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.webhook_failures[].entity_details.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.webhook_failures[].failure_time` | `string` | No | — | Field: failure\_time Maximum length: 255. |
| `result.data.webhook_failures[].failure_reason` | `string` | No | — | Field: failure\_reason Maximum length: 255. |
| `result.data.webhook_failures[].id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.webhook_failures[].workflow_rule` | `object` | No | — | Nested schema for workflow\_rule |
| `result.data.webhook_failures[].workflow_rule.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.webhook_failures[].workflow_rule.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.info` | `object` | No | — | Contains pagination metadata such as number of items per page, total count, current page number, and whether more records are available. |
| `result.data.info.max_limit` | `integer` | No | — | Field: max\_limit Format: `int32`. |
| `result.data.info.per_page` | `integer` | No | — | Field: per\_page Format: `int32`. |
| `result.data.info.count` | `integer` | No | — | Field: count Format: `int32`. |
| `result.data.info.page` | `integer` | No | — | Field: page Format: `int32`. |
| `result.data.info.more_records` | `boolean` | No | — | Field: more\_records |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Success response",
        "properties": {
          "webhook_failures": {
            "type": "array",
            "description": "Field: webhook_failures",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Nested schema for webhook_failures",
              "properties": {
                "webhook": {
                  "type": "object",
                  "description": "Nested schema for webhook",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "entity_details": {
                  "type": "object",
                  "description": "Nested schema for entity_details",
                  "properties": {
                    "module": {
                      "type": "object",
                      "description": "Provides details of a module within an automation assignment rule, including API name and module ID.",
                      "properties": {
                        "api_name": {
                          "type": "string",
                          "description": "Field: api_name",
                          "maxLength": 255
                        },
                        "id": {
                          "type": "string",
                          "description": "Field: id",
                          "maxLength": 255
                        }
                      },
                      "additionalProperties": false
                    },
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "failure_time": {
                  "type": "string",
                  "description": "Field: failure_time",
                  "maxLength": 255
                },
                "failure_reason": {
                  "type": "string",
                  "description": "Field: failure_reason",
                  "maxLength": 255
                },
                "id": {
                  "type": "string",
                  "description": "Field: id",
                  "maxLength": 255
                },
                "workflow_rule": {
                  "type": "object",
                  "description": "Nested schema for workflow_rule",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          },
          "info": {
            "type": "object",
            "description": "Contains pagination metadata such as number of items per page, total count, current page number, and whether more records are available.",
            "properties": {
              "max_limit": {
                "type": "integer",
                "description": "Field: max_limit",
                "format": "int32"
              },
              "per_page": {
                "type": "integer",
                "description": "Field: per_page",
                "format": "int32"
              },
              "count": {
                "type": "integer",
                "description": "Field: count",
                "format": "int32"
              },
              "page": {
                "type": "integer",
                "description": "Field: page",
                "format": "int32"
              },
              "more_records": {
                "type": "boolean",
                "description": "Field: more_records"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.