Zoho: Get webhook execution failure records

← Webhooks operations · Get started

Operation zoho.getwebhookfailures

Provider route: GET /crm/v8/settings/automation/webhook_failures. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["webhooks"]["getWebhookFailures"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.webhooks.getWebhookFailures(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.webhooks.get_webhook_failures(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.webhook_id	string	Optional	Maximum length: 20
query.module	string	Optional	Maximum length: 100
query.from	string	Optional	Format: date Maximum length: 10
query.to	string	Optional	Format: date Maximum length: 10
query.page	integer	Optional	Format: int32 Minimum: 1
query.per_page	integer	Optional	Format: int32 Maximum: 200 Minimum: 1

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get webhook execution failure records — response body — info, webhook failures
$ (anyOf 2)	null	Alternative

Referenced models: Get webhook execution failure records — response body — info, webhook failures

Schemas

Get webhook execution failure records — response body — info, webhook failures

Field	Type	Presence	Description and constraints
$	object	Root	Represents the paginated response containing webhook execution failure records. Filter by webhook_id, module API name, and date range using query parameters. Additional keys: not allowed
info	Model	Optional	Expand Get webhooks — response body — info Pagination metadata for navigating failure records.
webhook_failures	array	Optional	Represents the list of webhook execution failure detail objects. Maximum items: 200
webhook_failures[]	Model	Each item	Expand Get webhook execution failure records — response body — info, webhook failures webhook failures item

Referenced models: Get webhooks — response body — info, Get webhook execution failure records — response body — info, webhook failures webhook failures item

Get webhooks — response body — info

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination metadata returned with list responses. Additional keys: not allowed
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Represents the total number of webhooks returned in the current page. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_limit	JSON	Optional
max_limit (anyOf 1)	integer	Alternative	Represents the maximum number of records allowed per page for this resource. Format: int32
max_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Optional	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.
page	JSON	Optional
page (anyOf 1)	integer	Alternative	Represents the current page number in the paginated response. Format: int32
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Optional
per_page (anyOf 1)	integer	Alternative	Represents the number of records returned per page in the paginated response. Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get webhook execution failure records — response body — info, webhook failures webhook failures item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of a single webhook execution failure, including the triggering CRM record, workflow rule, failure reason, and timestamp. Additional keys: not allowed
entity_details	Model	Optional	Expand Get webhook execution failure records — response body — info, webhook failures webhook failures item entity details Details of the CRM record that triggered the failed webhook execution.
failure_reason	string	Optional	Represents the reason for the webhook execution failure, such as page_notfound. Maximum length: 255
failure_time	string	Optional	Represents the ISO 8601 timestamp of when the webhook execution failed. Maximum length: 255
id	string	Optional	Represents the unique identifier of the failure record. Maximum length: 255
webhook	Model	Optional	Expand Get webhook execution failure records — response body — info, webhook failures webhook failures item webhook Reference to the webhook that failed (id and name).
workflow_rule	Model	Optional	Expand Get webhook execution failure records — response body — info, webhook failures webhook failures item workflow rule Reference to the workflow rule that triggered the webhook.

Referenced models: Get webhook execution failure records — response body — info, webhook failures webhook failures item entity details, Get webhook execution failure records — response body — info, webhook failures webhook failures item webhook, Get webhook execution failure records — response body — info, webhook failures webhook failures item workflow rule

Get webhook execution failure records — response body — info, webhook failures webhook failures item entity details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of the CRM record whose automation event triggered a failed webhook execution. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the CRM record that triggered the webhook execution failure. Maximum length: 255
module	Model	Optional	Expand Get webhooks — response body — webhooks item module API name of the CRM module the triggering record belongs to.
name	string	Optional	Represents the display name of the CRM record that triggered the webhook execution failure. Maximum length: 255

Referenced models: Get webhooks — response body — webhooks item module

Get webhook execution failure records — response body — info, webhook failures webhook failures item webhook

Field	Type	Presence	Description and constraints
$	object	Root	Represents a lightweight reference to a webhook, containing its unique identifier and display name. Used in failure log records. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the webhook. Maximum length: 255
name	string	Optional	Represents the display name of the webhook. Maximum length: 255

Get webhook execution failure records — response body — info, webhook failures webhook failures item workflow rule

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reference to the workflow rule that triggered a webhook execution. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the workflow rule. Maximum length: 255
name	string	Optional	Represents the display name of the workflow rule. Maximum length: 255

Get webhooks — response body — webhooks item module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the CRM module reference identifying the parent module associated with a webhook. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the CRM module (for example, Leads, Contacts, Deals). Maximum length: 255
id	string	Required within parent	Represents the unique identifier of the CRM module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.getwebhookfailures. Catalog operation: getWebhookFailures. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source