Get Associated Modules for Webhook Actions

Purpose

To retrieve the list of modules that are associated with Webhook actions in the current CRM account.

Endpoints

GET /settings/automation/webhooks/actions/associated_modules

Request Details

Request URL

{api-domain}/crm/{version}/settings/automation/webhooks/actions/associated_modules

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.automation_actions.ALL
(or)
ZohoCRM.settings.automation_actions.READ

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/webhooks/actions/associated_modules"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET

Response JSON

associated_modulesJSON array
Lists the modules that webhook actions are associated with.
- api_namestring
  Represents the API name of the module.
- idstring
  The unique ID of the module.

Possible Errors

INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: This API supports only the GET method. Retry the request using the GET method.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have the required OAUTH SCOPE. Create a new token with valid scope. Refer to the Scope section for more details.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section for more details.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.

Sample Response

Copied{
    "associated_modules": [
        {
            "api_name": "Leads",
            "id": "4876876000000002175"
        },
        {
            "api_name": "Deals",
            "id": "4876876000000002181"
        }
    ]
}