Zoho: Get webhook by ID

← Webhooks operations · Get started

Operation zoho.getwebhookbyid

Provider route: GET /crm/v8/settings/automation/webhooks/{webhookId}. 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"]["getWebhookById"]>[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.getWebhookById(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_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.webhookId	string	Required within parent	Maximum length: 20

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 by ID — response body — webhooks
$ (anyOf 2)	null	Alternative

Referenced models: Get webhook by ID — response body — webhooks

Schemas

11 more schemas are linked from the tables above, on the schema pages.

Get webhook by ID — response body — webhooks

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response for retrieving a single webhook by ID, including the full webhook configuration with headers, body, url_parameters, authentication, and date_time_format. Additional keys: not allowed
webhooks	array	Optional	Represents the list containing the single requested webhook object with its full configuration. Maximum items: 1
webhooks[]	Model	Each item	Expand Get webhooks — response body — webhooks item

Referenced models: Get webhooks — response body — webhooks item

Get webhooks — response body — webhooks item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the full webhook object returned by the list and get-by-ID operations, including all configuration fields, audit metadata, and status indicators. Additional keys: not allowed
associated	boolean	Optional	Indicates whether this webhook is currently associated with at least one active Workflow Rule, Approval Process, or Blueprint. Possible values: **true** - The webhook is associated with at least one automation rule. **false** - The webhook is not associated with any automation rule.
authentication	Model	Optional	Expand Get webhooks — response body — webhooks item authentication Specify authentication details for the webhook endpoint. (Required)
body	Model	Optional	Expand Get webhooks — response body — webhooks item body Define the data that Zoho CRM sends in the body of the webhook request. This is applicable only for POST and PUT HTTP methods
created_by	Model	Optional	Expand Get webhooks — response body — webhooks item created by The CRM user who created this webhook.
created_time	string	Optional	Represents the ISO 8601 timestamp of when the webhook was created. Maximum length: 255
date_time_format	JSON	Optional
date_time_format (anyOf 1)	Model	Alternative	Expand Get webhooks — response body — webhooks item date time format value Date and time formatting configuration for this webhook's payloads. Null when no date/datetime merge-fields are used.
date_time_format (anyOf 2)	Model	Alternative	Expand Get webhooks — response body — webhooks item date time format value Date and time formatting configuration for this webhook's payloads. Null when no date/datetime merge-fields are used.
deletable	boolean	Optional	Indicates whether the current user can delete this webhook. Returns false for marketplace and extension-created webhooks. Possible values: **true** - The webhook can be deleted. **false** - The webhook cannot be deleted.
description	JSON	Optional
description (anyOf 1)	string	Alternative	Represents the optional user-provided description of the webhook purpose. Returns null when no description has been set. Maximum length: 255
description (anyOf 2)	null	Alternative	Represents the optional user-provided description of the webhook purpose. Returns null when no description has been set. Maximum length: 255
editable	boolean	Optional	Indicates whether the current user can edit this webhook. Returns false for marketplace and extension-created webhooks. Possible values: **true** - The webhook can be edited. **false** - The webhook cannot be edited.
feature_type	string	Required within parent	Represents the automation feature type this webhook belongs to. Possible values: **workflow** - Workflow Rule. **approval_process** - Approval Process. **blueprint** - Blueprint. **kiosk** - Kiosk feature. **commandcenter_service** - CommandCenter service. Maximum length: 255
headers	Model	Optional	Expand Get webhooks — response body — webhooks item headers Headers let you send extra information along with the webhook request. For example, API keys, authentication tokens, or custom values that the external application needs.
http_method	string	Required within parent	Represents the HTTP method used when the webhook fires. Possible values: **GET** - Sends a GET request to the webhook URL. **POST** - Sends a POST request to the webhook URL. **PUT** - Sends a PUT request to the webhook URL. **DELETE** - Sends a DELETE request to the webhook URL. Maximum length: 255
id	string	Optional	Represents the unique identifier of the webhook. Maximum length: 20
lock_status	Model	Optional	Expand Get webhooks — response body — webhooks item lock status Lock status of the webhook. Locked webhooks cannot be edited or deleted.
modified_by	Model	Optional	Expand Get webhooks — response body — webhooks item modified by The CRM user who last modified this webhook.
modified_time	string	Optional	Represents the ISO 8601 timestamp of when the webhook was last modified. Maximum length: 255
module	Model	Required within parent	Expand Get webhooks — response body — webhooks item module The parent CRM module that this webhook monitors for trigger events.
name	string	Required within parent	Represents the display name of the webhook. Maximum length: 50
related_module	JSON	Optional
related_module (anyOf 1)	Model	Alternative	Expand Get webhooks — response body — webhooks item related module value The child or dependent CRM module linked to this webhook's parent module. Null when no related module is configured.
related_module (anyOf 2)	Model	Alternative	Expand Get webhooks — response body — webhooks item related module value The child or dependent CRM module linked to this webhook's parent module. Null when no related module is configured.
source	JSON	Optional
source (anyOf 1)	string	Alternative	Represents the origin of the webhook. Returns null for legacy webhooks. Possible values: **user** - Created by a CRM user. **crm** - Created by the CRM system. **extension** - Created by a Marketplace extension. Maximum length: 255
source (anyOf 2)	null	Alternative	Represents the origin of the webhook. Returns null for legacy webhooks. Possible values: **user** - Created by a CRM user. **crm** - Created by the CRM system. **extension** - Created by a Marketplace extension. Maximum length: 255
url	string	Required within parent	Represents the destination URL that Zoho CRM sends the webhook request to when triggered. Maximum length: 255
url_parameters	JSON	Optional
url_parameters (anyOf 1)	Model	Alternative	Expand Get webhooks — response body — webhooks item url parameters value URL parameters for GET/DELETE webhook HTTP methods. Null when http_method is POST or PUT.
url_parameters (anyOf 2)	Model	Alternative	Expand Get webhooks — response body — webhooks item url parameters value URL parameters for GET/DELETE webhook HTTP methods. Null when http_method is POST or PUT.

Referenced models: Get webhooks — response body — webhooks item created by, Get webhooks — response body — webhooks item modified by, Get webhooks — response body — webhooks item module, Get webhooks — response body — webhooks item lock status, Get webhooks — response body — webhooks item date time format value, Get webhooks — response body — webhooks item related module value, Get webhooks — response body — webhooks item authentication, Get webhooks — response body — webhooks item headers, Get webhooks — response body — webhooks item body, Get webhooks — response body — webhooks item url parameters value

Get webhooks — response body — webhooks item created by

Field	Type	Presence	Description and constraints
$	object	Root	Represents the CRM user who created the webhook. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the user who created the webhook. Refer to the [Get Users](users.yaml#$.paths./users.get) resource for valid values. Maximum length: 255
name	string	Optional	Represents the display name of the user who created the webhook. Maximum length: 255

Get webhooks — response body — webhooks item modified by

Field	Type	Presence	Description and constraints
$	object	Root	Represents the CRM user who last modified the webhook. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the user who last modified the webhook. Refer to the [Get Users](users.yaml#$.paths./users.get) resource for valid values. Maximum length: 255
name	string	Optional	Represents the display name of the user who last modified the webhook. 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.getwebhookbyid. Catalog operation: getWebhookById. 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.

Refused by default. This operation leaves the caller holding a credential (Marked: the full webhook returns its headers, URL parameters and form-data custom_parameters values, which Zoho documents as the place for API keys and authentication tokens sent to the external application, a third-party credential read out of Zoho.), so Alter refuses it on every connection with credential_minting_refused unless an organization admin allows it: a credential_minting rule naming provider zoho and operation zoho.getwebhookbyid (or getWebhookById). See Allow an operation that hands over a credential.

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