To Get the List of Webhooks
Description
This API can be used to get the list of all the Webhooks available in your portal.
Query Parameters
- type (Mandatory) - To list the specific type of webhooks, the value of the type can be data or administration.
- app_ids - To specify the app IDs and fetch the webhooks associated with the particular apps alone (applicable only for Data webhook.)
- sort_by - To sort the list of webhooks with the +created_time and -created_time (sort based on the webhook created time, the (+) denotes ascending order and (-) denotes descending order), +modified_time and -modified_time (sort based on the Webhook modified time, the (+) denotes ascending order and (-) denotes descending order). By default, the list will be sorted by +modified_time. If no value is provided then the default value will be executed.
OAuth Scope:
SalesIQ.webhooks.READ
URL:
Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/webhooksExample:
Copiedhttps://salesiq.zoho.com/api/v2/zylker/webhooksSample Response
Copied{
"url": "/api/v2/zylker/webhooks",
"object": "list",
"data": [
{
"modified_time": "1566675582717",
"url": "https://zylker/webhooks.ext",
"expiry_time_for_executions_data": "5184000000",
"id": "19367000000120005",
"modifier": {
"id": "19367000000002079"
},
"creator": {
"id": "19367000000002079"
},
"status": "enabled",
"failures_count": "15",
"secured": true,
"app_ids": [
"19367000000002043"
],
"version": 1,
"type": "data",
"created_time": "1566663989384"
},
{
"modified_time": "1566675540229",
"url": "https://zylker/webhooks.ext",
"expiry_time_for_executions_data": "5184000000",
"id": "19367000000120007",
"modifier": {
"id": "19367000000002079"
},
"creator": {
"id": "19367000000002079"
},
"status": "disabled",
"failures_count": "15",
"secured": true,
"app_ids": [
"19367000000002043"
],
"version": 1,
"type": "data",
"created_time": "1566674450128"
}
],
"sync_time": "1566888626776"
}