Get all Webhooks
Use this API to retrieve a list of webhooks used in your application.
Request Type
GET
Request URL
https://campaigns.zoho.com/emailapi/v2/settings/webhook
Content-Type
application/json
List of Response Body Attributes
| Parameters | Data Type | Description |
| from_index | Integer | Indicates starting number in the overall dataset where the returned data begins. |
| total_webhook_count | Integer | Total number of webhooks configured. |
| webhook_list | JSON Array | Contains information about all the webhooks. |
| created_time | String | Time at which webhook was created (in milliseconds). |
| is_active | Boolean | Returns a true or false value indicating if the webhook is active or not. |
| webhook_id | String | Unique ID of a webhook that can be used in APIs. |
| name | String | Name of the webhook. |
| type | String | Depicts the request type of the API. Example: POST, PUT, etc. |
| created_by | String | Name of the user from whose account webhook was created using API. |
| url | String | The URL to which information about emails should be sent. |
| limit | Integer | Indicates the number of webhooks to be returned in the response, starting from the from_index value. |
| response | JSON Object | Contains the response details of the API. |
| code | Integer | Success or failure code. |
| message | String | Success or failure message returned by the API. |
Sample Response - Success
Copied{
"from_index": 0,
"total_webhook_count": 0,
"webhook_list": [
{
"created_time": "1675947040032",
"is_active": true,
"webhook_id": "5000000322042",
"name": "Bounce new webhook",
"type": "POST",
"created_by": "Zylker",
"url": "https://zylker.com/bounceone"
},
{
"created_time": "1675948485102",
"is_active": true,
"webhook_id": "5000000322074",
"name": "Bounce webhook 1",
"type": "POST",
"created_by": "Zylker",
"url": "https://zylker.com/bounceonenew"
},
],
"limit": 200,
"response": {
"code": 200201,
"message": "Successfully obtained the list of configured webhooks"
}
}
