Setting up Webhooks
Webhooks are one way that apps can send automated messages or information to other apps. They facilitate communication with third-party applications by sending instant web notifications every time an event occurs in Zoho Desk. All you need to do is register a URL that we will notify anytime an event happens in your help desk.
Here are some of the situations when you'll want to create a webhook:
- After closing a ticket, you can push the time spent information to an accounting software where you can generate an invoice.
- Add requestors to the mailing list in email marketing software to whom you can send seasonal mailers later.
- Trigger text messages to field service agents about customer appointments, location details, and other service-specific events. It is akin to how your bank sends you a text message when you make a new purchase.
Feature Availability and Limits
Permission Required Agents with Webhooks permission under Support Administrator permission profile can access this feature.
Check Feature Availability and Limits
Please check the availability and limits of webhooks for your Zoho Desk edition below:
|
Editions
|
Availability
|
Limits
|
|
Free
|
Not Available
|
--
|
|
Standard
|
Not Available
|
--
|
|
Professional
|
Available
|
5 Active
|
|
Enterprise
|
Available
|
10 Active
|
Note:
- The source ID should be entered in the UUID format
- Webhooks are org-based, and you can only have a maximum of 20 webhooks (including active and inactive) at any point in time.
- Only open webhooks that are publicly accessible and do not require authentication are supported. NotifyURL with payloads in webhooks are not supported.
- Webhooks created using an extension cannot be edited or deactivated within Zoho Desk; they can only be edited and deactivated in the extension itself.
- To read more on webhooks.
Supported Modules and Events
Modules are the subsets of information that you see in your Zoho Desk. You can subscribe to listen to some of the module-specific events so that you can trigger updates in other third-party applications. The modules and their respective events are listed below:
|
Modules
|
Module-specific Events
|
|
Tickets
|
Add
|
|
|
Update specific fields with previous value
|
|
|
Update specific fields without previous value |
|
|
Update with previous value
|
|
|
Update without previous value
|
|
|
Delete
|
|
|
Incoming threads
|
|
|
Outgoing threads |
|
|
All threads
|
|
|
Add comment
|
|
|
Update comment
|
|
|
Add attachment
|
|
|
Update attachment
|
|
Delete attachment
|
|
|
|
Approval add
|
|
|
Approval update with previous value
|
|
|
Approval update without previous value
|
|
|
|
|
Contacts
|
Add
|
|
|
Update with previous value
|
|
|
Update without previous value
|
|
|
Delete
|
|
|
|
|
Accounts
|
Add
|
|
|
Update with previous value
|
|
|
Update without previous value
|
|
|
Delete
|
|
|
|
|
Departments
|
Add
|
|
Update with previous value
|
|
|
|
Update without previous value
|
|
|
|
|
Agents
|
Add
|
|
|
Update with previous value
|
|
|
Update without previous value
|
|
|
Delete
|
|
|
|
|
Tasks
|
Add
|
|
|
Update with previous value
|
|
|
Update without previous value
|
|
|
Delete
|
|
|
|
|
Time Entry
|
Add
|
|
|
Update with previous value
|
|
|
Update without previous value
|
|
|
Delete
|
|
|
|
| Articles |
Add
|
|
|
Update with previous value
|
|
|
Update without previous value
|
|
|
Delete
|
|
|
Translation add
|
|
|
Translation update with previous value
|
|
|
Translation update without previous value
|
|
|
Translation delete
|
|
|
Feedback add
|
|
|
|
|
KB Category
|
Add
|
|
|
Update with previous value
|
|
|
Update without previous value
|
|
|
Delete
|
|
|
|
|
KB Section
|
Add
|
|
|
Update with previous value
|
|
|
Update without previous value
|
|
|
Delete
|
For the Update specific fields with previous value and Update specific fields without previous value events in the Tickets module, we can choose upto five fields only.
Creating Webhooks
Webhooks can be created in Developer Space > Webhooks, or they can be created through extensions.
To create a webhook:
- Navigate to Setup > Developer Space > Webhooks
- On the Webhooks List page, click Add your First Webhook or New Webhook.
- On the New Webhook page, do the following:
- Enter the webhook's name in the Name field
- In the URL to Notify, enter the REST API URL of the third-party application. This will be the callback URL.
- Add a description for the webhook
- Specify the source ID in UUID format to be used by the listener when performing other API-related actions. Learn more.
- Under Choose Event, select the module, event and the department details
You can click the ( + ) icon to add and subscribe to multiple events - Click Test Run to check whether the URL entered is valid by posting a sample payload to it.
- Click Save.
Zoho Desk will make an HTTP POST to the endpoint URL whenever the chosen events are triggered.
Clicking on the MODULE-EVENT column will display the number of events in the specified webhook. Meanwhile, clicking on the events will pop up a small tab with an overview list of all the events in the webhook.
<Image>
Users can Test Run (), Edit ( ) or Delete ( ) icon corresponding to the webhook to run a sample test, make changes, or delete it, respectively.The Webhook can be deactivated by toggling the active button. The toggle can also be turn ON back corresponding to it to activate the webhook again.
Filtering webhooks
Webhooks can be filtered to quickly locate a particular webhook without scrolling through the entire list.
Webhooks can be filtered using the following criteria:
- Modules - Select the module and tab to find the associated webhook.
- Events - Select the events that are configured to trigger eg., Add/Delete/Update/Add comment/Session status and etc.., .
- Status - Webhook status, such as:
- Select All - Show both active and inactive webhooks.
- Active - Display only the active webhooks.
- Inactive - Display all the disabled webhooks.
Important:
- Special characters are not allowed in the Name, URL to notify, and Description fields.
- You cannot retrieve data from other third-party apps to Zoho Desk using webhooks.
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:
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
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.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Zoho Calendar Integration Block in GC
The Zoho Calendar Integration block (formerly known System Blocks) simplifies connecting your calendar to GC in Zoho Desk. By transforming complex webhook configurations into reusable blocks, this feature allows you to manage and automate calendar ...Adding, Editing, and Deleting Events
If you intend to schedule an activity on Zoho Desk that has a specific place, time, and duration, you need to use events. Zoho Desk's built-in event manager provides an easy way to manage your events. By using the Zoho Desk's events, you and your ...Events Supported in the Get Ticket History API
Introduction The Get ticket history API returns details of the actions — called events — performed on a ticket. In this document, you will learn about the different events supported and the variations of each event. Ticket History Events Each event ...FAQs: Custom Actions Gallery
What is Custom Actions Gallery? Custom actions gallery includes a set of custom actions that help you automate key tasks, like assigning tickets, adding/removing tags, adding followers/comments, sending email replies, replying and notifying via ...Set Up IM Message and Session Status Webhooks
Never miss a conversation update in IM! With the IM webhooks, you’ll know right away when a live chat or instant message session changes status, so you can respond quickly, keep your team informed. IM Message Add Event This event is triggered ...
New to Zoho LandingPage?
Zoho LandingPage Resources