Platform Event Callbacks
Marketplace supports callbacks for extension's events. Developer can subscribe to the supported events and when the extension event is triggered, callbacks are invoked.
Supported Platform Event Callback's are,
- onInstall
- onZohoAuthorise
- onTPAAuthorise
- onTPARevoke
- onUpdate
- onConfigParamAdd
- onConfigParamDelete
- onUninstall
Sample plugin-manifest.json
- ...
- "callbackListener":{
- "onZohoAuthorise": "https://zohodeskapp.com/authorized.php%22,
- "onConfigParamAdd": "https://zohodeskapp.com/adjustfiler.php%22,
- "onUninstall": "https://zohodeskapp.com/revokeWebhook.php%22
- },
- ...
Subscribing to the Events
Extension manifest's callbackListener property is used for declaring the callbacks for the extension's events. To subscribe to an event, specify the callback URL in the manifest for the callbackListener's respective event.
Event Callback Request
Whenever the extension event occurs, the callback URL is triggered with security parameters which can be used to call the authenticated APIs.
Sample Event Callback Request
URL : manifest.callbackListener.{eventName}
RequestMethod : POST
RequestHeaders : HASH
Content-Type : application/json
RequestBody : JSONObject in #EVENT_CALLBACK_PAYLOAD_FORMAT format.
EVENT_CALLBACK_URL
https://zohodeskapp.com/authorized.php
EVENT_CALLBACK_HEADERS
- {
- "HASH" : "xxxxxxxxx"
- }
EVENT_CALLBACK_PAYLOAD_FORMAT
- {
- "event" : "onZohoAuthorise",
- "orgId" : 387238,
- "securityContext" : "2398deio3qwnx3c9xwi3nc3njkh9jfico"
- }
#EVENT_CALLBACK_PAYLOAD_FORMAT
Events
onInstall
onInstall will be triggered when the customer installs an extension. The developer can subscribe to the event with the URL and perform his logic.
Example Usage
Creating a Third party resource once the customer installs the extension.
onZohoAuthorise
Once the end user installs the extension, he needs to authorize the desk & TPA (say jira). onZohoAuthorise will be triggered when the customer authorize the DESK. The developer can subscribe to the event with the URL and perform his logic.
Example Usecase
Creating a Zoho Desk webhook once the desk authorization is completed.
onTPAAuthorise
The event will be triggered once the user authorize the Third party app.
Example Usecase
Subscribing or creating a webhook in third party service.
onTPARevoke
The event will be triggered once the user revoke the Third party app authorization.
Example Usecase
Revoking or deleting the added webhooks in the third party services.
onUpdate
The event will be triggered when the user upgrade the extension.
Example Usecase
Adding or Updating config params.
onConfigParamAdd
The event will be triggered when the customer adds configuration params in the extension.
Example Usecase
In jira extension, when customer adds configuration params such as domain, jiraAuthKey , developer shall create a jira webhook against the jira account.
onConfigParamDelete
The event will be triggered when the customer adds configuration params in the extension.
Example Usecase
In jira extension, when customer deletes configuration params such as domain, jiraAuthKey , developer shall delete jira webhook in the jira account.
onUninstall
The event is triggered when customer uninstall the extension.
Example Usecase
Operations to be performed during un-installation such as deleting webhooks.
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 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?
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
Pricing using a subscription management platform
This guide will help you with the following: Create Pricing Plans in the Developer Console Setup in Zoho Subscriptions Add Plans in Zoho Subscriptions Create Add-ons Create Webhooks Add a Custom Field Create a Broker Application Subscription APIs The ...Event APIs
The following APIs help you incorporate custom functionalities in your extension when certain events occur in your help desk portal. Ticket Events You can configure extensions to receive information when an event, such as adding a comment to a ticket ...HIPAA Compliance with Zoho Developer - Vertical Solutions Platform
ZohoDeveloper - Vertical Solutions Platform is currently available in developer.zoho.com and developer.zoho.eu and is expected to release in developer.zoho.in and in developer.zoho.com.au. The Health Insurance Portability and Accountability Act ...CRM Platform Modules and Fields
You can use API to integrate with the following standard modules: API support is not available for the Forecasts module. You must use the API format given the above table. If you use "leads" for "Leads" module or "purchaseorders" for "Purchase ...Connections
Connections enable you to connect to any of your native Vertical solution or third-party or other Zoho services using OAuth 2.0 authorization. It abstracts the entire OAuth2.0 authorization flow and keeps your code simple, clean, and crisp. Once the ...
New to Zoho LandingPage?
Zoho LandingPage Resources