Zoho: Get webhook-associated modules

← Webhooks operations · Get started

Operation zoho.getwebhookassociatedmodules

Provider route: GET /crm/v8/settings/automation/webhooks/actions/associated_modules. 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"]["getWebhookAssociatedModules"]>[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.getWebhookAssociatedModules(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_associated_modules(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

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
$	Model	Root	Expand Get webhook-associated modules — response body

Referenced models: Get webhook-associated modules — response body

Schemas

Get webhook-associated modules — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response listing CRM modules that have at least one webhook associated. Additional keys: not allowed
associated_modules	array	Optional	Represents the list of module references that have at least one webhook associated. Maximum items: 2
associated_modules[]	Model	Each item	Expand Get webhook-associated modules — response body — associated modules item

Referenced models: Get webhook-associated modules — response body — associated modules item

Get webhook-associated modules — response body — associated modules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM module reference that has at least one webhook associated. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the CRM module. Maximum length: 255
id	string	Optional	Represents the unique module identifier. 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.getwebhookassociatedmodules. Catalog operation: getWebhookAssociatedModules. 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