Overview
Using APIs you can programmatically create, view, update, delete outgoing webhooks in Zoho Connect.
Attributes of the Webhook
The following attributes of the webhook are needed to create, view, update or delete Outgoing Webhooks using APIs.
Name | Data Type | Description | Pre requisite |
id | Long | Unique Id of the webhook | Read only |
name | String(50) | Name of the webhook | Mandatory |
description | String (250) | Description of the webhook | Optional |
url | String (500) | Server endpoint to which event information must be sent | Mandatory |
active | Boolean Default value : true | Key that returns if the webhook is enabled or not. | Optional |
createdBy | Long | ID of user who created the webhook | Read only |
createdTime | Long | Time of webhook creation. | Read only |
autoRetry | Boolean default value : false | Key that returns if the auto retry option is enabled or not | Optional |
triggers | JSONArray | Array of triggers for which the webhook action should be performed | Mandatory |
Attributes Of the webhook trigger
The following attributes are present in a webhook trigger payload.
Name | Data Type | Description | Pre requisite |
type | String | Unique key of the Webhook Trigger | Mandatory |
partitionIds | JSONArray of partitionIds | The ID of the Connect entities in which the trigger action has been done.
| Optional |