Extension Webhook
Marketplace supports Extension Webhook , which will allow a market place app to create extension specific desk webhooks. Extension webhook access is restricted to the extension app alone so that the normal user can't make any changes on these webhooks.
An extension developer can specify the webhook details in resources.json file. Extension webhooks will be created on authorising the extension and will be deleted on uninstalling the extension. We will apply department filtering on webhook events based on the departments choosed in the extesnion configuration.
On subscribing extension webhook we will append the orgId and securityContext to the webhook callback url. You can use this information to make API calls using Desk's invoke API.
Sample resources.json
- "webhook":{
- "resourceName": "webhook1",
- "url": "https://demowebhook.com/callbackurl%22,
- "name": "Demo extension webhook",
- "description": "Demo extension webhook listen to ticket events",
- "subscriptions":{
- "Ticket_Add":null,
- "Ticket_Update":{
- "includePrevState":true
- },
- "Ticket_Thread_Add":null,
- "Ticket_Comment_Add":null,
- "Ticket_Comment_Update":null
- }
- "ignoreSourceId":"2df92c1a-973a-48f5-95b7-5792c68b9c36"
- },
Note: Extension webhook is allowed only for org based extensions
How to handle Authorisation
To use extension webhook you should include the webhook specific scope Desk.events.ALL in the authorisation scope list and the authorisation should be defined using the key zohoAuthorisationin plugin-manifest file.
Sample of Manifest entry with Zoho Authorization - using Connnections (Desk.events.ALL scope should be included in connection scope list)
- {
- "zohoAuthorisation" : {
- "type" : "connectors",
- "connectionLinkName" : "test12345",
- "connectionName" : "Webhook zoho desk",
- "serviceName" : "Zoho Oauth",
- "userAccess" : true,
- "scope" : ["Desk.events.ALL"],
- "isUserDefinedService" : false
- },
- }
#WEBHOOK_FIELDS
(Refer Webhook's Attribute section to know more about webhook fileds.We will apply department filtering on webhook events based on the departments choosed in the extesnion configuration. Kindly ignore the departmentIds key while giving the subscription details in resources.json file.)
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:
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?
Zoho DataPrep Resources
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
Extension Incoming Webhook Handler
Integration with external applications can be done with the help of incoming webhook APIs. An extension token or ZAPI key generated by each user interacting with the extension, should be used for handling incoming webhooks and messaging apis. You ...Extension Properties
What are extension properties? Extension properties are values associated with the extension. They are quite similar to regular data properties, wherein you map a key of type string with a value string. The main purpose is to store data ...Extension Installation Handler
This handler is triggered after the installation of the extension. The main purpose of this handler is to let you (extension creator) handle certain processes, like configuring webhooks after a user installs the extension. Click Edit Code under ...Extension Token (ZAPI Key)
The extension token, also known as ZAPI Key is an unique authentication key generated for each user who interacts with any component in the extension. This token can be used to connect your extension with a third party application through webhooks, ...Extension Installation Validator
The installation validator is triggered to validate the user before installing the extension. The validator is not configured by default. If the installation validator is not configured, users will be allowed to install the extension without ...
New to Zoho LandingPage?
Zoho LandingPage Resources