OpenAPI specification for Zoho CRM Webhooks (settings/automation) — endpoints to create, list, update, delete webhooks, inspect failures and usage reports. Targets CRM v8 automation workflows and integrations.
{
"openapi": "3.1.0",
"info": {
"title": "Webhooks",
"description": "OpenAPI specification for Zoho CRM Webhooks (settings/automation) — endpoints to create, list, update, delete webhooks, inspect failures and usage reports. Targets CRM v8 automation workflows and integrations.",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"description": "API Server URL TLD",
"default": "com",
"enum": [
"com",
"eu",
"in",
"cn",
"au",
"ca",
"jp"
]
},
"version": {
"description": "API Version",
"default": "v8"
}
}
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.CREATE",
"ZohoCRM.settings.automation_actions.READ",
"ZohoCRM.settings.automation_actions.UPDATE",
"ZohoCRM.settings.automation_actions.DELETE",
"ZohoCRM.settings.automation_actions.ALL",
"ZohoCRM.settings.ALL"
]
}
],
"paths": {
"/settings/automation/webhooks": {
"get": {
"summary": "GET /settings/automation/webhooks",
"description": "Retrieve all available webhooks configured in your Zoho CRM account.",
"operationId": "getWebhooks",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryModule"
},
{
"$ref": "#/components/parameters/ParamQueryPage"
},
{
"$ref": "#/components/parameters/ParamQueryPerPage"
},
{
"$ref": "#/components/parameters/ParamQuerySortBy"
},
{
"$ref": "#/components/parameters/ParamQuerySortOrder"
},
{
"$ref": "#/components/parameters/ParamQueryFeatureType"
},
{
"$ref": "#/components/parameters/ParamQueryRelatedModule"
},
{
"$ref": "#/components/parameters/ParamQueryFilters"
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetWebhooksSuccessResponse"
}
}
}
},
"400": {
"description": "Given param is invalid .",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/InvalidModuleErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidDataErrorResponse"
}
]
}
}
}
},
"403": {
"description": "When the user doesn't have permission.\n(manageworkflow)",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/NoPermissionErrorResponse"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.READ"
]
}
]
},
"put": {
"summary": "PUT /settings/automation/webhooks",
"description": "To update an existing webhook available in your Zoho CRM account.",
"operationId": "putWebhooks",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema7"
}
}
}
},
"responses": {
"200": {
"description": "Success Case",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema20"
}
}
}
},
"400": {
"description": "Auto-generated from ApiDefinition for INVALID_DATA",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore4"
},
{
"$ref": "#/components/schemas/AmbiguityProcessingErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidNameErrorResponse"
},
{
"$ref": "#/components/schemas/NameLimitExceededErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidMethodTypeErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidUrlErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidDateFormatErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidTimezoneErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidDateTimeFormatErrorResponse"
},
{
"$ref": "#/components/schemas/ErrorResponseCore3"
},
{
"$ref": "#/components/schemas/UnsupportedMergeFieldErrorResponse"
},
{
"$ref": "#/components/schemas/DuplicateDataErrorResponse"
},
{
"$ref": "#/components/schemas/ErrorResponseCore10"
},
{
"$ref": "#/components/schemas/ErrorResponseCore17"
},
{
"$ref": "#/components/schemas/ErrorResponseCore13"
},
{
"$ref": "#/components/schemas/ErrorResponseCore"
},
{
"$ref": "#/components/schemas/ErrorResponseCore18"
},
{
"$ref": "#/components/schemas/ErrorResponseCore5"
},
{
"$ref": "#/components/schemas/ErrorResponseCore11"
},
{
"$ref": "#/components/schemas/ErrorResponseCore16"
},
{
"$ref": "#/components/schemas/ErrorResponseCore8"
}
]
},
"maxItems": 25
}
},
"required": [
"webhooks"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore12"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore8"
}
},
"required": [
"webhooks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore11"
}
},
"required": [
"webhooks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore16"
}
},
"required": [
"webhooks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore15"
}
},
"required": [
"webhooks"
]
}
]
}
}
}
},
"403": {
"description": "When the user doesn't have permission.\n(manageworkflow)",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/NoPermissionErrorResponse"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.UPDATE"
]
}
]
},
"post": {
"summary": "POST /settings/automation/webhooks",
"description": "Webhooks in Zoho CRM allow you to send real-time data from Zoho CRM to external applications or services when specific events occur such as Record creation, update, or deletion.",
"operationId": "postWebhooks",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhooksRequestBody"
}
}
}
},
"responses": {
"201": {
"description": "SUCCESS response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhooksSuccessResponse"
}
}
}
},
"400": {
"description": "Auto-generated from ApiDefinition for INVALID_DATA",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2"
},
{
"$ref": "#/components/schemas/ErrorResponseCore4"
},
{
"$ref": "#/components/schemas/AmbiguityProcessingErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidNameErrorResponse"
},
{
"$ref": "#/components/schemas/NameLimitExceededErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidMethodTypeErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidUrlErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidDateFormatErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidTimezoneErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidDateTimeFormatErrorResponse"
},
{
"$ref": "#/components/schemas/UnsupportedMergeFieldErrorResponse"
},
{
"$ref": "#/components/schemas/DuplicateDataErrorResponse"
},
{
"$ref": "#/components/schemas/ErrorResponseCore10"
},
{
"$ref": "#/components/schemas/ErrorResponseCore17"
},
{
"$ref": "#/components/schemas/ErrorResponseCore13"
},
{
"$ref": "#/components/schemas/ErrorResponseCore"
},
{
"$ref": "#/components/schemas/ErrorResponseCore18"
},
{
"$ref": "#/components/schemas/ErrorResponseCore11"
},
{
"$ref": "#/components/schemas/ErrorResponseCore16"
},
{
"$ref": "#/components/schemas/ErrorResponseCore8"
}
]
},
"maxItems": 25
}
},
"required": [
"webhooks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore8"
}
},
"required": [
"webhooks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore11"
}
},
"required": [
"webhooks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore16"
}
},
"required": [
"webhooks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore15"
}
},
"required": [
"webhooks"
]
}
]
}
}
}
},
"403": {
"description": "When the user doesn't have permission.\n(manageworkflow)",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/NoPermissionErrorResponse"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.CREATE"
]
}
]
},
"delete": {
"summary": "DELETE /settings/automation/webhooks",
"description": "To delete one or more webhooks configured in your Zoho CRM account. You can delete up to 10 webhooks in a single API call.",
"operationId": "deleteWebhooks",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryIds"
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema4"
}
}
}
},
"207": {
"description": "When one webhook got deleted successfully while other tasks failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema2"
}
}
}
},
"400": {
"description": "Only maximum of 10 actions can be deleted",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore6"
},
{
"$ref": "#/components/schemas/ErrorResponseCore9"
}
]
}
}
}
},
"403": {
"description": "When the user doesn't have permission.\n(manageworkflow)",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/NoPermissionErrorResponse"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.DELETE"
]
}
]
}
},
"/settings/automation/webhooks/{webhookId}": {
"get": {
"summary": "GET /settings/automation/webhooks/{webhookId}",
"description": "Retrieve the webhooks configured in your Zoho CRM account.",
"operationId": "getWebhookById",
"parameters": [
{
"name": "webhookId",
"in": "path",
"description": "The ID of the webhook to retrieve.",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"responses": {
"200": {
"description": "SUCCESS RESPONSE ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema18"
}
}
}
},
"204": {
"description": "No content"
},
"403": {
"description": "When the user doesn't have permission.\n(manageworkflow)",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/NoPermissionErrorResponse"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.READ"
]
}
]
},
"put": {
"summary": "PUT /settings/automation/webhooks",
"description": "To update an existing webhook available in your Zoho CRM account.",
"operationId": "putWebhooksById",
"parameters": [
{
"name": "webhookId",
"in": "path",
"description": "The ID of the webhook to retrieve.",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema7"
}
}
}
},
"responses": {
"200": {
"description": "Success Case",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema20"
}
}
}
},
"400": {
"description": "Auto-generated from ApiDefinition for INVALID_DATA",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore4"
},
{
"$ref": "#/components/schemas/AmbiguityProcessingErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidNameErrorResponse"
},
{
"$ref": "#/components/schemas/NameLimitExceededErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidMethodTypeErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidUrlErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidDateFormatErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidTimezoneErrorResponse"
},
{
"$ref": "#/components/schemas/InvalidDateTimeFormatErrorResponse"
},
{
"$ref": "#/components/schemas/ErrorResponseCore3"
},
{
"$ref": "#/components/schemas/UnsupportedMergeFieldErrorResponse"
},
{
"$ref": "#/components/schemas/DuplicateDataErrorResponse"
},
{
"$ref": "#/components/schemas/ErrorResponseCore10"
},
{
"$ref": "#/components/schemas/ErrorResponseCore17"
},
{
"$ref": "#/components/schemas/ErrorResponseCore13"
},
{
"$ref": "#/components/schemas/ErrorResponseCore"
},
{
"$ref": "#/components/schemas/ErrorResponseCore18"
},
{
"$ref": "#/components/schemas/ErrorResponseCore5"
},
{
"$ref": "#/components/schemas/ErrorResponseCore11"
},
{
"$ref": "#/components/schemas/ErrorResponseCore16"
},
{
"$ref": "#/components/schemas/ErrorResponseCore8"
}
]
},
"maxItems": 25
}
},
"required": [
"webhooks"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore12"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore8"
}
},
"required": [
"webhooks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore11"
}
},
"required": [
"webhooks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore16"
}
},
"required": [
"webhooks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"$ref": "#/components/schemas/ErrorResponseCore15"
}
},
"required": [
"webhooks"
]
}
]
}
}
}
},
"403": {
"description": "When the user doesn't have permission.\n(manageworkflow)",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/NoPermissionErrorResponse"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.UPDATE"
]
}
]
},
"delete": {
"summary": "DELETE /settings/automation/webhooks/{webhookId}",
"description": "To delete one webhooks configured in your Zoho CRM account.",
"operationId": "deleteWebhooksById",
"parameters": [
{
"name": "webhookId",
"in": "path",
"description": "The ID of the webhook to delete.",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"responses": {
"200": {
"description": "Success delete",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema15"
}
}
}
},
"400": {
"description": "Invalid ID",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore12"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with webhooks",
"properties": {
"webhooks": {
"type": "array",
"description": "Array of error objects",
"items": {
"$ref": "#/components/schemas/ErrorResponseCore3"
},
"maxItems": 25
}
# --- truncated at 32 KB (121 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-webhooks-openapi.json