Update webhooks

PUT/settings/automation/webhooks

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Update webhooks action (under Webhooks).
Fill in the fields below, then reference the result from later steps as {{updateWebhooks.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

webhooksarray<object>required

Represents the list containing exactly one webhook object with the full replacement configuration.

idstring

Represents the unique identifier of the webhook to update. The ID is required in the request body when using the bulk update endpoint.

namestringrequired

Specify the display name of the webhook. The name must not contain the tilde (~) character. The name cannot be changed for kiosk feature actions.

moduleobjectrequired2 fields

Represents the CRM module reference identifying the parent module associated with a webhook.

urlstringrequired

Specify the destination URL that receives the webhook request when triggered. The URL must begin with http://, https://, www., or a merge-field token (${...}). URLs resolving to internal or private host addresses are rejected by SSRF protection.

http_methodstringrequired

Specify the HTTP method used when the webhook fires. Possible values: **POST** - Sends a POST request. **GET** - Sends a GET request. **PUT** - Sends a PUT request. **DELETE** - Sends a DELETE request.

One ofPOSTGETPUTDELETE

authenticationobjectrequired2 fields

Represents the authentication configuration for the webhook endpoint. Use type **general** for endpoints that do not require credentials. Use type **connection** with a valid connection_name for endpoints that require authenticated access via a pre-configured Zoho connection.

descriptionstring | null

Specify the optional description of the webhook purpose.

related_moduleobject | null2 fields

Represents a reference to a related CRM module linked to the parent module of a webhook. Returns null when no related module is configured. Required when feature_type is kiosk.

feature_typestringrequired

Specify the automation feature type for this webhook. Possible values: **workflow** - Workflow Rule. **approval_process** - Approval Process. **blueprint_transition** - Blueprint transition. **blueprint_state** - Blueprint state. **assignment_rules** - Assignment Rules. **kiosk** - Kiosk feature. **commandcenter_service** - CommandCenter service.

One ofworkflowapproval_processblueprint_transitionblueprint_stateassignment_ruleskioskcommandcenter_service

headersobject2 fields

Represents the HTTP headers configuration for the outgoing webhook request. Supports module merge-field parameters and custom static parameters. The host header name is reserved and cannot be used.

url_parametersobject | null3 fields

Represents the URL query parameters appended to the webhook request URL. Applicable only when http_method is GET or DELETE. Returns null when http_method is POST or PUT.

bodyobject4 fields

Represents the request body configuration for the outgoing webhook request. For type **form_data**, provide form_data_content with module_parameters and custom_parameters; format may be null. For type **raw**, supply raw_data_content and a format value of JSON, XML, Text, or HTML. For type **none**, the body carries no content and format may be null.

date_time_formatobject | null3 fields

Represents the date and time formatting configuration applied to date or datetime merge-field values in webhook request payloads. Applicable only when a date or datetime merge-field is used in headers, url_parameters, or body. Returns null when no date or datetime merge-fields are present.

json

{
  "webhooks": [
    {
      "name": "string",
      "module": {
        "api_name": "string",
        "id": "string"
      },
      "url": "string",
      "http_method": "POST",
      "authentication": {
        "type": "general",
        "connection_name": "string"
      },
      "feature_type": "workflow",
      "id": "5725767000007186002",
      "description": "string",
      "related_module": {
        "api_name": "string",
        "id": "string"
      },
      "headers": {
        "custom_parameters": null,
        "module_parameters": null
      },
      "url_parameters": {
        "custom_parameters": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "module_parameters": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "user_defined_parameters": {
          "name": "string",
          "value": "string"
        }
      },
      "body": {
        "format": "JSON",
        "type": "form_data",
        "raw_data_content": "string",
        "form_data_content": {
          "module_parameters": [
            {
              "name": null,
              "value": null
            }
          ],
          "user_defined_parameter": {
            "name": "string",
            "value": "string"
          },
          "custom_parameters": [
            {
              "name": null,
              "value": null
            }
          ]
        }
      }
    }
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{updateWebhooks.response.data.<field>}}.

webhooksarray<object>

Represents the list containing the operation result for the updated webhook.

codestringrequired

Represents the success or error code of the webhook operation.

detailsobjectrequired1 fields

Represents the nested object containing the unique identifier of the webhook returned by a mutation operation.

messagestringrequired

Represents the description of the operation result.

statusstringrequired

Represents the operation status.

json

{
  "webhooks": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "string"
      },
      "message": "webhook created successfully",
      "status": "string"
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?