Zoho: Delete one or more webhooks

← Webhooks operations · Get started

Operation zoho.deletewebhooks

Provider route: DELETE /crm/v8/settings/automation/webhooks. 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"]["deleteWebhooks"]>[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.deleteWebhooks(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.delete_webhooks(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.ids	string	Required within parent	Maximum length: 250

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 Delete one or more webhooks — response body — webhooks — Bulk Delete Webhooks Success Response
$ (anyOf 2)	Model	Alternative	Expand Delete one or more webhooks — response body — webhooks — Bulk Delete Partial Success Response

Referenced models: Delete one or more webhooks — response body — webhooks — Bulk Delete Partial Success Response, Delete one or more webhooks — response body — webhooks — Bulk Delete Webhooks Success Response

Schemas

Delete one or more webhooks — response body — webhooks — Bulk Delete Partial Success Response

Field	Type	Presence	Description and constraints
$	object	Root	Represents the HTTP Multi-Status response for bulk webhook deletion when results are mixed, indicating that at least one webhook was deleted and at least one deletion failed. Additional keys: not allowed
webhooks	array	Optional	Represents the list of operation results, containing a mix of success and error entries for each webhook deletion attempt. Maximum items: 10
webhooks[]	Model	Each item	Expand Webhooks — response body — webhooks item

Referenced models: Webhooks — response body — webhooks item

Delete one or more webhooks — response body — webhooks — Bulk Delete Webhooks Success Response

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response for a bulk webhook deletion where all specified webhooks were deleted. Additional keys: not allowed
webhooks	array	Optional	Represents the list of operation results confirming each webhook deletion. Maximum items: 10
webhooks[]	Model	Each item	Expand Webhooks — response body — webhooks item

Referenced models: Webhooks — response body — webhooks item

Webhooks — response body — webhooks item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the operation result for a webhook create, update, or delete action. On success, code is success, status is success, and details contains the webhook ID. Additional keys: not allowed
code	string	Required within parent	Represents the success or error code of the webhook operation. Maximum length: 255
details	Model	Required within parent	Expand Webhooks — response body — webhooks item details Result details. On success, contains the webhook id.
message	string	Required within parent	Represents the description of the operation result. Maximum length: 255
status	string	Required within parent	Represents the operation status. Maximum length: 255

Referenced models: Webhooks — response body — webhooks item details

Webhooks — response body — webhooks item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested object containing the unique identifier of the webhook returned by a mutation operation. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the webhook. Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.deletewebhooks. Catalog operation: deleteWebhooks. 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.

Official provider source