Zoho: Webhooks schemas
46 Zoho schemas with complete fields and constraints.
← Webhooks operations · All schemas
Delete a webhook by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the success response for deleting a single webhook by its ID. Additional keys: not allowed |
webhooks | array | Optional | Represents the list containing the operation result for the deleted webhook. Maximum items: 1 |
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 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
Get webhook action usage reports — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a successful response from an automation usage report endpoint. Contains an array of daily usage data points alongside pagination metadata that includes the edition-specific daily execution cap. When no usage exists for the queried period, the endpoint returns an empty data array rather than null, and the response resolves with HTTP 200. Additional keys: not allowed |
data_usage | array | Optional | Contains the collection of usage data points for the queried period. Each entry represents the execution count for a specific automation action on a given date. Returns an empty array when no usage exists for the queried period. Maximum items: 200 |
data_usage[] | Model | Each item | Expand Get webhook action usage reports — response body — data usage item |
info | Model | Optional | Expand Get webhook action usage reports — response body — info Pagination metadata including the edition-specific daily execution cap. |
Referenced models: Get webhook action usage reports — response body — data usage item, Get webhook action usage reports — response body — info
Get webhook action usage reports — response body — data usage item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single daily usage data point capturing the execution count for an automation action. When the group_by parameter includes resource, the embedded resource object identifies the individual email notification or webhook. When group_by is date only, the resource object is omitted and the count reflects total executions across all actions for that day. The type field indicates the automation feature responsible for the executions, such as workflow_rules, approval_process, or Blueprint. Additional keys: not allowed |
count | JSON | Optional | |
count (anyOf 1) | integer | Alternative | Represents the number of times the automation action was executed on this date. When the group_by parameter is set to 'date' only, this value reflects the total across all actions. Format: int32 Minimum: 0 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
date | string | Optional | Represents the date of this usage data point in YYYY-MM-DD format. All dates are evaluated in the organization's time zone. Format: date Maximum length: 10 |
resource | Model | Optional | Expand Get webhook action usage reports — response body — data usage item resource Reference to the specific automation action (email notification or webhook) that generated the usage count. Only present when group_by includes 'resource'. |
type | string | Optional | Represents the automation feature type associated with the reported executions. Values correspond to the filter types supported by the type query parameter, such as workflow_rules, approval_process, Blueprint, email_notifications, webhooks, and kiosks. Maximum length: 50 |
Referenced models: Get webhook action usage reports — response body — data usage item resource
Get webhook action usage reports — response body — data usage item resource
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to the specific automation action that generated usage. The identifier and name are resolved from the action's configuration record; for deleted actions, the name falls back to the corresponding automation audit log entry. When the include_inner_details parameter includes resource.layout_id and the action is associated with a wizard layout, a layout_id field is included in the representation. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the automation action, such as an email notification ID or a webhook ID. Maximum length: 20 |
layout_id | string | Optional | Represents the identifier of the wizard layout associated with the automation action. Present only when the include_inner_details query parameter is set to resource.layout_id and the action is linked to a wizard layout. Maximum length: 20 |
name | string | Optional | Represents the display name of the automation action. Falls back to the name recorded in the automation audit log when the action has been deleted. Maximum length: 255 |
Get webhook action usage reports — response body — info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents pagination metadata returned with automation usage report responses. Includes a max_limit value that reflects the edition-specific daily execution cap for the relevant action type, derived from the organization's feature limits. Additional keys: not allowed |
count | JSON | Optional | |
count (anyOf 1) | integer | Alternative | Represents the number of records included in the current page of results. Format: int32 Minimum: 0 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_limit | JSON | Optional | |
max_limit (anyOf 1) | integer | Alternative | Represents the edition-specific daily execution cap for the automation action type. For email notifications, this reflects the WORKFLOWALERT day limit; for webhooks, it reflects the WFWEBHOOK day limit. Lower-tier editions carry smaller caps. Format: int32 Minimum: 0 |
max_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Optional | Indicates whether additional pages of results are available beyond the current page. Possible values: true - More records exist beyond the current page. false - The current page contains the last records. |
page | JSON | Optional | |
page (anyOf 1) | integer | Alternative | Represents the one-based index of the current page within the paginated result set. Format: int32 Minimum: 1 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
per_page | JSON | Optional | |
per_page (anyOf 1) | integer | Alternative | Represents the number of records returned in each page of the result set. Format: int32 Maximum: 200 Minimum: 1 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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 webhook execution failure records — response body — info, webhook failures
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the paginated response containing webhook execution failure records. Filter by webhook_id, module API name, and date range using query parameters. Additional keys: not allowed |
info | Model | Optional | Expand Get webhooks — response body — info Pagination metadata for navigating failure records. |
webhook_failures | array | Optional | Represents the list of webhook execution failure detail objects. Maximum items: 200 |
webhook_failures[] | Model | Each item | Expand Get webhook execution failure records — response body — info, webhook failures webhook failures item |
Referenced models: Get webhooks — response body — info, Get webhook execution failure records — response body — info, webhook failures webhook failures item
Get webhook execution failure records — response body — info, webhook failures webhook failures item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details of a single webhook execution failure, including the triggering CRM record, workflow rule, failure reason, and timestamp. Additional keys: not allowed |
entity_details | Model | Optional | Expand Get webhook execution failure records — response body — info, webhook failures webhook failures item entity details Details of the CRM record that triggered the failed webhook execution. |
failure_reason | string | Optional | Represents the reason for the webhook execution failure, such as page_notfound. Maximum length: 255 |
failure_time | string | Optional | Represents the ISO 8601 timestamp of when the webhook execution failed. Maximum length: 255 |
id | string | Optional | Represents the unique identifier of the failure record. Maximum length: 255 |
webhook | Model | Optional | Expand Get webhook execution failure records — response body — info, webhook failures webhook failures item webhook Reference to the webhook that failed (id and name). |
workflow_rule | Model | Optional | Expand Get webhook execution failure records — response body — info, webhook failures webhook failures item workflow rule Reference to the workflow rule that triggered the webhook. |
Referenced models: Get webhook execution failure records — response body — info, webhook failures webhook failures item entity details, Get webhook execution failure records — response body — info, webhook failures webhook failures item webhook, Get webhook execution failure records — response body — info, webhook failures webhook failures item workflow rule
Get webhook execution failure records — response body — info, webhook failures webhook failures item entity details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details of the CRM record whose automation event triggered a failed webhook execution. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the CRM record that triggered the webhook execution failure. Maximum length: 255 |
module | Model | Optional | Expand Get webhooks — response body — webhooks item module API name of the CRM module the triggering record belongs to. |
name | string | Optional | Represents the display name of the CRM record that triggered the webhook execution failure. Maximum length: 255 |
Referenced models: Get webhooks — response body — webhooks item module
Get webhook execution failure records — response body — info, webhook failures webhook failures item webhook
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a lightweight reference to a webhook, containing its unique identifier and display name. Used in failure log records. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the webhook. Maximum length: 255 |
name | string | Optional | Represents the display name of the webhook. Maximum length: 255 |
Get webhook execution failure records — response body — info, webhook failures webhook failures item workflow rule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to the workflow rule that triggered a webhook execution. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the workflow rule. Maximum length: 255 |
name | string | Optional | Represents the display name of the workflow rule. Maximum length: 255 |
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 |
Get webhooks — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the paginated success response for listing webhooks. Contains summary-level webhook objects without headers, body, authentication, or date_time_format details. Additional keys: not allowed |
info | Model | Optional | Expand Get webhooks — response body — info Pagination metadata for navigating the result set. |
webhooks | array | Optional | Represents the list of webhook summary objects returned by the list operation. Maximum items: 200 |
webhooks[] | Model | Each item | Expand Get webhooks — response body — webhooks item |
Referenced models: Get webhooks — response body — webhooks item, Get webhooks — response body — info
Get webhooks — response body — info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the pagination metadata returned with list responses. Additional keys: not allowed |
count | JSON | Optional | |
count (anyOf 1) | integer | Alternative | Represents the total number of webhooks returned in the current page. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_limit | JSON | Optional | |
max_limit (anyOf 1) | integer | Alternative | Represents the maximum number of records allowed per page for this resource. Format: int32 |
max_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Optional | Indicates whether additional pages of results are available. Possible values: **true** - More records exist beyond the current page. **false** - The current page contains the last records. |
page | JSON | Optional | |
page (anyOf 1) | integer | Alternative | Represents the current page number in the paginated response. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
per_page | JSON | Optional | |
per_page (anyOf 1) | integer | Alternative | Represents the number of records returned per page in the paginated response. Format: int32 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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 authentication
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. Additional keys: not allowed |
connection_name | JSON | Optional | |
connection_name (anyOf 1) | string | Alternative | Represents the name of the Zoho connection used for authentication. This field is required only when **type** is **connection**. Maximum length: 255 |
connection_name (anyOf 2) | null | Alternative | Represents the name of the Zoho connection used for authentication. This field is required only when **type** is **connection**. Maximum length: 255 |
type | string | Required within parent | Specify the authentication method for the webhook endpoint. Possible values: **general** - No credentials required. **connection** - Uses a pre-configured Zoho connection. Known values: general, connection Maximum length: 255 |
Get webhooks — response body — webhooks item body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. Additional keys: not allowed |
form_data_content | Model | Optional | Expand Get webhooks — response body — webhooks item body form data content Form data content when body type is form_data. Contains module parameters, custom parameters, and an optional user-defined parameter. |
format | JSON | Required within parent | |
format (anyOf 1) | string | Alternative | Specify the body content format. Possible values: **JSON** - JSON format. **XML** - XML format. **Text** - Plain text format. **HTML** - HTML format. **null** - Valid for form_data and none body types. Known values: JSON, XML, Text, HTML Maximum length: 25 |
format (anyOf 2) | null | Alternative | Specify the body content format. Possible values: **JSON** - JSON format. **XML** - XML format. **Text** - Plain text format. **HTML** - HTML format. **null** - Valid for form_data and none body types. Known values: JSON, XML, Text, HTML Maximum length: 25 |
raw_data_content | JSON | Optional | |
raw_data_content (anyOf 1) | string | Alternative | Represents the raw string content sent as the request body. This field is required when the body type is raw. Maximum length: 500 |
raw_data_content (anyOf 2) | null | Alternative | Represents the raw string content sent as the request body. This field is required when the body type is raw. Maximum length: 500 |
type | string | Required within parent | Specify the body type for the webhook request. Possible values: **form_data** - Sends data as key-value pairs in the request body. **raw** - Sends plain text, JSON, HTML, or XML content directly. **none** - No body content. Known values: form_data, raw, none Maximum length: 255 |
Referenced models: Get webhooks — response body — webhooks item body form data content
Get webhooks — response body — webhooks item body form data content
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the form data body content for webhook requests when body.type is form_data. Contains module merge-field parameters, custom static parameters, and an optional user-defined parameter. Additional keys: not allowed |
custom_parameters | array | Optional | Represents the custom static key-value pairs sent as form data in the webhook request. Maximum items: 10 |
custom_parameters[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers custom parameters item |
module_parameters | array | Optional | Represents the module merge-field parameters resolved at runtime and sent as form data in the webhook request. Maximum items: 25 |
module_parameters[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers module parameters item |
user_defined_parameter | Model | Optional | Expand Webhooks — request body — body webhooks item url parameters user defined parameters A single user-defined key-value parameter sent as a form data field. Note: The API uses singular 'user_defined_parameter' for form_data_content (this field) and plural 'user_defined_parameters' for url_parameters - both are single objects, not arrays. |
Referenced models: Webhooks — request body — body webhooks item url parameters user defined parameters, Webhooks — request body — body webhooks item headers custom parameters item, Webhooks — request body — body webhooks item headers module parameters item
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 date time format value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | 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. Additional keys: not allowed |
$ (anyOf 1).date_format | string | Optional | Represents the format pattern for date-only merge-field values in the webhook payload. Maximum length: 255 |
$ (anyOf 1).datetime_format | string | Optional | Represents the format pattern for datetime merge-field values in the webhook payload. Maximum length: 255 |
$ (anyOf 1).time_zone | string | Optional | Represents the timezone identifier applied to datetime merge-field values in the webhook payload. Maximum length: 255 |
$ (anyOf 2) | null | Alternative | 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. Additional keys: not allowed |
$ (anyOf 2).date_format | string | Optional | Represents the format pattern for date-only merge-field values in the webhook payload. Maximum length: 255 |
$ (anyOf 2).datetime_format | string | Optional | Represents the format pattern for datetime merge-field values in the webhook payload. Maximum length: 255 |
$ (anyOf 2).time_zone | string | Optional | Represents the timezone identifier applied to datetime merge-field values in the webhook payload. Maximum length: 255 |
Get webhooks — response body — webhooks item headers
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. Additional keys: not allowed |
custom_parameters | JSON | Optional | |
custom_parameters (anyOf 1) | array | Alternative | Represents the static key-value pairs sent as HTTP headers with every webhook execution. Maximum items: 10 |
custom_parameters (anyOf 1)[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers custom parameters item |
custom_parameters (anyOf 2) | null | Alternative | Represents the static key-value pairs sent as HTTP headers with every webhook execution. Maximum items: 10 |
custom_parameters (anyOf 2)[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers custom parameters item |
module_parameters | JSON | Optional | |
module_parameters (anyOf 1) | array | Alternative | Represents the module merge-field parameters sent as HTTP headers. The key must be present but may be an empty array when only custom parameters are needed. Maximum items: 25 |
module_parameters (anyOf 1)[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers module parameters item |
module_parameters (anyOf 2) | null | Alternative | Represents the module merge-field parameters sent as HTTP headers. The key must be present but may be an empty array when only custom parameters are needed. Maximum items: 25 |
module_parameters (anyOf 2)[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers module parameters item |
Referenced models: Webhooks — request body — body webhooks item headers custom parameters item, Webhooks — request body — body webhooks item headers module parameters item
Get webhooks — response body — webhooks item lock status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the lock status of the webhook. Locked webhooks cannot be edited or deleted. Additional keys: not allowed |
locked | boolean | Optional | Indicates whether the webhook is currently locked. Locked webhooks cannot be edited or deleted. Possible values: **true** - The webhook is locked. **false** - The webhook is not locked. |
message | JSON | Optional | |
message (anyOf 1) | string | Alternative | Represents the reason the webhook is locked. Returns null when the webhook is not locked. Maximum length: 255 |
message (anyOf 2) | null | Alternative | Represents the reason the webhook is locked. Returns null when the webhook is not locked. 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 |
Get webhooks — response body — webhooks item related module value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | 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. Additional keys: not allowed |
$ (anyOf 1).api_name | string | Optional | Represents the API name of the related CRM module. Maximum length: 255 |
$ (anyOf 1).id | string | Optional | Represents the unique identifier of the related CRM module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Maximum length: 255 |
$ (anyOf 2) | null | Alternative | 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. Additional keys: not allowed |
$ (anyOf 2).api_name | string | Optional | Represents the API name of the related CRM module. Maximum length: 255 |
$ (anyOf 2).id | string | Optional | Represents the unique identifier of the related CRM module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Maximum length: 255 |
Get webhooks — response body — webhooks item url parameters value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | 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. Additional keys: not allowed |
$ (anyOf 1).custom_parameters | array | Optional | Represents the static key-value pairs appended as URL query parameters to every webhook request. Each entry must have a unique name. - name (string, optional) Specify a name to the custom header. - value (string, optional) Specify a value to the custom header. "custom_parameters": [ { "name": "OAuth", "value": "2.0" } ]. A maximum of 10 entries is allowed. Maximum items: 10 |
$ (anyOf 1).custom_parameters[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers custom parameters item |
$ (anyOf 1).module_parameters | array | Optional | Represents the module merge-field parameters appended as URL query parameters. Values are resolved at runtime from the triggering CRM record using the merge-field format (for example, ${!Leads.Email}). Use the [Get Fields Metadata](fields.yaml#$.paths./settings/fields.get) resource to retrieve valid field API names. Maximum items: 25 |
$ (anyOf 1).module_parameters[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers module parameters item |
$ (anyOf 1).user_defined_parameters | Model | Optional | Expand Webhooks — request body — body webhooks item url parameters user defined parameters A single user-defined parameter appended as a URL query parameter. Note: The API uses plural 'user_defined_parameters' here but singular 'user_defined_parameter' in form_data_content - both are single objects, not arrays. |
$ (anyOf 2) | null | Alternative | 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. Additional keys: not allowed |
$ (anyOf 2).custom_parameters | array | Optional | Represents the static key-value pairs appended as URL query parameters to every webhook request. Each entry must have a unique name. - name (string, optional) Specify a name to the custom header. - value (string, optional) Specify a value to the custom header. "custom_parameters": [ { "name": "OAuth", "value": "2.0" } ]. A maximum of 10 entries is allowed. Maximum items: 10 |
$ (anyOf 2).custom_parameters[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers custom parameters item |
$ (anyOf 2).module_parameters | array | Optional | Represents the module merge-field parameters appended as URL query parameters. Values are resolved at runtime from the triggering CRM record using the merge-field format (for example, ${!Leads.Email}). Use the [Get Fields Metadata](fields.yaml#$.paths./settings/fields.get) resource to retrieve valid field API names. Maximum items: 25 |
$ (anyOf 2).module_parameters[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers module parameters item |
$ (anyOf 2).user_defined_parameters | Model | Optional | Expand Webhooks — request body — body webhooks item url parameters user defined parameters A single user-defined parameter appended as a URL query parameter. Note: The API uses plural 'user_defined_parameters' here but singular 'user_defined_parameter' in form_data_content - both are single objects, not arrays. |
Referenced models: Webhooks — request body — body webhooks item url parameters user defined parameters, Webhooks — request body — body webhooks item headers custom parameters item, Webhooks — request body — body webhooks item headers module parameters item
Update webhooks — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request body wrapper for updating a webhook. The webhooks array must contain exactly one webhook object. Additional keys: not allowed |
webhooks | array | Required within parent | Represents the list containing exactly one webhook object with the full replacement configuration. Maximum items: 1 Minimum items: 1 |
webhooks[] | Model | Each item | Expand Update webhooks — request body — body webhooks item |
Referenced models: Update webhooks — request body — body webhooks item
Update webhooks — request body — body webhooks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the writable fields for updating an existing webhook. Full-replacement semantics apply all required fields must be present, as omitted fields reset to defaults or null. The module field is immutable; providing a different module returns NOT_ALLOWED. System-managed read-only fields must be omitted. Additional keys: not allowed |
authentication | Model | Required within parent | Expand Webhooks — request body — body webhooks item authentication Authentication configuration. |
body | Model | Optional | Expand Webhooks — request body — body webhooks item body Request body. Only allowed when http_method is POST or PUT. type and format are required. When type=form_data: provide form_data_content (object with module_parameters and custom_parameters arrays); format may be null. When type=raw: provide raw_data_content (string) and format (JSON, XML, Text, or HTML). When type=none: format may be null. |
date_time_format | Model | Optional | Expand Webhooks — request body — body webhooks item date time format Optional. Only relevant when a date or datetime merge-field is used in any parameter (headers, url_parameters, or body). Use datetime_format + time_zone for datetime fields, date_format for date fields. Ignored if no date/datetime merge-fields are present. |
description | string or null | Optional | Specify the optional description of the webhook purpose. Maximum length: 500 |
feature_type | string | Required within parent | 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 of: workflow, approval_process, blueprint_transition, blueprint_state, assignment_rules, kiosk, commandcenter_service Maximum length: 255 |
headers | Model | Optional | Expand Webhooks — request body — body webhooks item headers HTTP headers. Only allowed when http_method is POST, PUT, or DELETE. Restricted header name: HOST is not allowed. Parameter names must be unique (DUPLICATE_DATA). |
http_method | string | Required within parent | 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 of: POST, GET, PUT, DELETE |
id | string | Optional | Represents the unique identifier of the webhook to update. The ID is required in the request body when using the bulk update endpoint. Maximum length: 20 |
module | Model | Required within parent | Expand Get webhooks — response body — webhooks item module The CRM module. Cannot be changed - providing a different module returns NOT_ALLOWED. |
name | string | Required within parent | Specify the display name of the webhook. The name must not contain the tilde (~) character. The name cannot be changed for kiosk feature actions. Maximum length: 250 |
related_module | Model | Optional | Expand Webhooks — request body — body webhooks item related module Related CRM module. Required when feature_type is kiosk. |
url | string | Required within parent | 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. Maximum length: 2000 |
url_parameters | Model | Optional | Expand Webhooks — request body — body webhooks item url parameters URL query parameters. Only allowed when http_method is GET or DELETE. |
Referenced models: Get webhooks — response body — webhooks item module, Webhooks — request body — body webhooks item date time format, Webhooks — request body — body webhooks item related module, Webhooks — request body — body webhooks item authentication, Webhooks — request body — body webhooks item headers, Webhooks — request body — body webhooks item body, Webhooks — request body — body webhooks item url parameters
Update webhooks — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the success response for a webhook update operation, including the operation result and the updated webhook ID. Additional keys: not allowed |
webhooks | array | Optional | Represents the list containing the operation result for the updated webhook. Maximum items: 1 |
webhooks[] | Model | Each item | Expand Webhooks — response body — webhooks item |
Referenced models: Webhooks — response body — webhooks item
Webhooks — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request body wrapper for creating a webhook. The webhooks array must contain exactly one webhook object. Additional keys: not allowed |
webhooks | array | Required within parent | Represents the list containing exactly one webhook object to create. Maximum items: 1 Minimum items: 1 |
webhooks[] | Model | Each item | Expand Webhooks — request body — body webhooks item |
Referenced models: Webhooks — request body — body webhooks item
Webhooks — request body — body webhooks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the writable fields for creating a new webhook. Required fields are name, module, url, http_method, authentication, and feature_type. System-managed fields must not be included. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid module API names. Additional keys: not allowed |
authentication | Model | Required within parent | Expand Webhooks — request body — body webhooks item authentication Authentication configuration. Required for all webhooks, including those without authentication credentials. Use type=general for webhooks that do not require authentication (no connection_name needed). Use type=connection when the webhook endpoint requires authenticated access via a pre-configured connection (connection_name is required). |
body | Model | Optional | Expand Webhooks — request body — body webhooks item body Request body configuration. Only allowed when http_method is POST or PUT. type and format are required. When type=form_data: provide form_data_content (object with module_parameters and custom_parameters arrays); When type=raw: provide raw_data_content (string) and format (JSON, XML, Text, or HTML). When type=none: format may be null. |
date_time_format | Model | Optional | Expand Webhooks — request body — body webhooks item date time format Optional. Only relevant when a date or datetime merge-field is used in any parameter (headers, url_parameters, or body). Use datetime_format + time_zone when a datetime field is referenced (e.g., ${!Leads.Created_Time}). Use date_format when a date field is referenced (e.g., ${!Leads.Date_1}). Ignored if no date/datetime merge-fields are present. |
description | string or null | Optional | Specify the optional description of the webhook purpose. Maximum length: 500 |
feature_type | string | Required within parent | 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 of: workflow, approval_process, blueprint_transition, blueprint_state, assignment_rules, kiosk, commandcenter_service Maximum length: 255 |
headers | Model | Optional | Expand Webhooks — request body — body webhooks item headers HTTP headers for the outgoing webhook request. Only allowed when http_method is POST, PUT, or DELETE. Restricted header name: HOST is not allowed. Parameter names must be unique across the collection (DUPLICATE_DATA). |
http_method | string | Required within parent | Specify the HTTP method used when the webhook fires. POST and PUT accept headers and body. GET and DELETE accept url_parameters. DELETE also accepts headers. Possible values: **POST** - Sends a POST request. **GET** - Sends a GET request. **PUT** - Sends a PUT request. **DELETE** - Sends a DELETE request. One of: POST, GET, PUT, DELETE |
module | Model | Required within parent | Expand Get webhooks — response body — webhooks item module The CRM module this webhook is associated with. Provide at least one of api_name or id. Cannot be changed after creation. |
name | string | Required within parent | Specify the display name of the webhook. The name must not contain the tilde (~) character. Maximum length: 250 |
related_module | Model | Optional | Expand Webhooks — request body — body webhooks item related module Related CRM module. Required when feature_type is kiosk. Null otherwise. |
url | string | Required within parent | 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. Maximum length: 2000 |
url_parameters | Model | Optional | Expand Webhooks — request body — body webhooks item url parameters URL query parameters for the outgoing request. Only allowed when http_method is GET or DELETE. |
Referenced models: Get webhooks — response body — webhooks item module, Webhooks — request body — body webhooks item date time format, Webhooks — request body — body webhooks item related module, Webhooks — request body — body webhooks item authentication, Webhooks — request body — body webhooks item headers, Webhooks — request body — body webhooks item body, Webhooks — request body — body webhooks item url parameters
Webhooks — request body — body webhooks item authentication
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. Additional keys: not allowed |
connection_name | string or null | Optional | Represents the name of the Zoho connection used for authentication. This field is required only when **type** is **connection**. Maximum length: 255 |
type | string | Required within parent | Specify the authentication method for the webhook endpoint. Possible values: **general** - No credentials required. **connection** - Uses a pre-configured Zoho connection. One of: general, connection Maximum length: 255 |
Webhooks — request body — body webhooks item body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. Additional keys: not allowed |
form_data_content | Model | Optional | Expand Get webhooks — response body — webhooks item body form data content Form data content when body type is form_data. Contains module parameters, custom parameters, and an optional user-defined parameter. |
format | string or null | Required within parent | Specify the body content format. Possible values: **JSON** - JSON format. **XML** - XML format. **Text** - Plain text format. **HTML** - HTML format. **null** - Valid for form_data and none body types. One of: JSON, XML, Text, HTML, null Maximum length: 25 |
raw_data_content | string or null | Optional | Represents the raw string content sent as the request body. This field is required when the body type is raw. Maximum length: 500 |
type | string | Required within parent | Specify the body type for the webhook request. Possible values: **form_data** - Sends data as key-value pairs in the request body. **raw** - Sends plain text, JSON, HTML, or XML content directly. **none** - No body content. One of: form_data, raw, none Maximum length: 255 |
Referenced models: Get webhooks — response body — webhooks item body form data content
Webhooks — request body — body webhooks item date time format
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object or null | Root | 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. Additional keys: not allowed |
date_format | string | Optional | Represents the format pattern for date-only merge-field values in the webhook payload. Maximum length: 255 |
datetime_format | string | Optional | Represents the format pattern for datetime merge-field values in the webhook payload. Maximum length: 255 |
time_zone | string | Optional | Represents the timezone identifier applied to datetime merge-field values in the webhook payload. Maximum length: 255 |
Webhooks — request body — body webhooks item headers
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. Additional keys: not allowed |
custom_parameters | array or null | Optional | Represents the static key-value pairs sent as HTTP headers with every webhook execution. Maximum items: 10 |
custom_parameters[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers custom parameters item |
module_parameters | array or null | Optional | Represents the module merge-field parameters sent as HTTP headers. The key must be present but may be an empty array when only custom parameters are needed. Maximum items: 25 |
module_parameters[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers module parameters item |
Referenced models: Webhooks — request body — body webhooks item headers custom parameters item, Webhooks — request body — body webhooks item headers module parameters item
Webhooks — request body — body webhooks item headers custom parameters item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a static key-value parameter for webhook requests. Used in headers, URL query parameters, or form data fields. The value is a fixed literal sent unchanged with every webhook execution. Additional keys: not allowed |
name | string | Optional | Represents the parameter key sent in the webhook request. Maximum length: 255 |
value | string | Optional | Represents the static literal value sent with every webhook execution. Maximum length: 255 |
Webhooks — request body — body webhooks item headers module parameters item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a module merge-field parameter for webhook requests. Used in headers, URL query parameters, or form data fields. The value is resolved at runtime from the field of the triggering CRM record. Additional keys: not allowed |
name | string | Optional | Represents the parameter key sent in the webhook request. The name must be unique within the parameter collection. Maximum length: 255 |
value | string | Optional | Represents the merge-field token resolved at runtime from the triggering CRM record. Use the API field names and not display names (for example, use ${!Leads.Last_Name}, not ${!Leads.Last Name}). Invalid API names return INVALID_DATA. Maximum length: 255 |
Webhooks — request body — body webhooks item related module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object or null | Root | 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. Additional keys: not allowed |
api_name | string | Optional | Represents the API name of the related CRM module. Maximum length: 255 |
id | string | Optional | Represents the unique identifier of the related CRM module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Maximum length: 255 |
Webhooks — request body — body webhooks item url parameters
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object or null | Root | 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. Additional keys: not allowed |
custom_parameters | array | Optional | Represents the static key-value pairs appended as URL query parameters to every webhook request. Each entry must have a unique name. - name (string, optional) Specify a name to the custom header. - value (string, optional) Specify a value to the custom header. "custom_parameters": [ { "name": "OAuth", "value": "2.0" } ]. A maximum of 10 entries is allowed. Maximum items: 10 |
custom_parameters[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers custom parameters item |
module_parameters | array | Optional | Represents the module merge-field parameters appended as URL query parameters. Values are resolved at runtime from the triggering CRM record using the merge-field format (for example, ${!Leads.Email}). Use the [Get Fields Metadata](fields.yaml#$.paths./settings/fields.get) resource to retrieve valid field API names. Maximum items: 25 |
module_parameters[] | Model | Each item | Expand Webhooks — request body — body webhooks item headers module parameters item |
user_defined_parameters | Model | Optional | Expand Webhooks — request body — body webhooks item url parameters user defined parameters A single user-defined parameter appended as a URL query parameter. Note: The API uses plural 'user_defined_parameters' here but singular 'user_defined_parameter' in form_data_content - both are single objects, not arrays. |
Referenced models: Webhooks — request body — body webhooks item url parameters user defined parameters, Webhooks — request body — body webhooks item headers custom parameters item, Webhooks — request body — body webhooks item headers module parameters item
Webhooks — request body — body webhooks item url parameters user defined parameters
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the single user-defined key-value parameter included in webhook request payloads. Additional keys: not allowed |
name | string | Optional | Represents the key name of the user-defined parameter. Maximum length: 255 |
value | string | Optional | Represents the value of the user-defined parameter. Maximum length: 255 |
Webhooks — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the success response for a webhook creation request, including the operation result and the new webhook ID. Additional keys: not allowed |
webhooks | array | Optional | Represents the list containing the operation result for the created webhook, including the new webhook ID. Maximum items: 1 |
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 |