Outgoing Webhook APIs - An overview
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 |
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
All-in-one knowledge management and training platform for your employees and customers.
Create. Review. Publish.
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Design. Discuss. Deliver.
Related Articles
Managing outgoing webhooks
Overview An outgoing webhook lets you send real-time updates from Zoho Connect to third-party apps. You can choose which activities trigger these updates. Who can configure? By default, only network admins can set up outgoing webhooks. Admins can ...Delete Webhook
Overview This API deletes an existing webhook. After this API is executed, the URL in the webhook stops receiving trigger information. API DELETE /api/v1/webhook/{id} Oauth Scope ZohoPulse.outgoingwebhook.DELETE Sample request $curl -X DELETE ...Update Webhook
Overview This API updates the details of an existing outgoing webhook. You change the webhook name, description, triggers and also the URL. If the URL is altered, a validation post call (Ping trigger) is sent to the new URL. API PATCH ...Get webhook
Overview This API fetches a single outgoing webhook from your Zoho Connect network. API GET /api/v1/webhook/{id} Oauth Scope ZohoPulse.outgoingwebhook.READ Sample request $curl -X GET https://connect.zoho.com/api/v1/webhook/1234XXXX67 ...Create Webhook
Overview This API creates an outgoing webhook in your Zoho Connect network. When this API is invoked, a validation post call (ping trigger) is sent to the URL end-point. That URL end-point must respond with a 200 OK message to confirm the creation of ...