Extension pointers -JS SDK series#9: A look at multiple JS SDK API methods and their potential uses in different scenarios for widgets
Throughout the "Extension Pointers - JS SDK" series, we've demonstrated a wide range of APIs, their usage, and how they can be implemented in a widget, along with working examples. Let's look at a consolidation of all the APIs in this post, to get a quick overview of how APIs can be used in specific scenarios.
All of the scenarios below are based on the assumption that you intend and decide to incorporate widgets into your extension.
Scenario 1
Assume you've developed an extension with a connector for integrating a third-party application. You may now have to perform several operations, such as:
- Retrieving records or related data from a Zoho CRM module to push into the third-party application
- Fetching third-party application data in order to either insert or update the data in Zoho CRM modules
To implement these functionalities, you'll need to use the appropriate JS SDK API methods.
Let's take a look at the API methods that can be useful during the above-mentioned scenario:
ZOHO.CRM.API.getRecord | Gets all the details of a record |
ZOHO.CRM.API.getRelatedRecords | Retrieves related list records |
ZOHO.CRM.API.updateRecord | Updates a record in a module |
ZOHO.CRM.CONNECTOR.invokeAPI | Invokes Connector API |
ZOHO.CRM.CONNECTOR.authorize | Prompts the Connector Authorize window |
You can refer to this post to understand in detail about working with connectors in a widget, with the help of a working example.
Scenario 2
Assume you want to invoke a Deluge custom function from your widget. The execute SDK method will be handy in this case:
ZOHO.CRM.FUNCTIONS.execute | Invokes a function and return response |
You'll have to construct the parameters required for the function and pass it to the execute method, along with the function's API name. Refer to this post for a complete working example.
Note: Only REST API functions can be invoked from a widget using invokeAPI.
Also, when dealing with a Zoho CRM module's meta data, you can use the ZOHO.CRM.META API method.
Refer to this link to get a detailed working example for getting the metadata of fields in modules.
Scenario 3
As important as it is to add new information to a record, it's equally important to delink the information when changes occur, in order to keep information up to date. Similarly, there are other activities you'll need to perform to implement your business scenarios, like adding notes to the record field to provide additional details on the changes made.
The API methods that will help cover this are:
ZOHO.CRM.API.getRelatedRecords | Retrieves related list records |
ZOHO.CRM.API.delinkRelatedRecord | Delinks the relation between the records |
ZOHO.CRM.API.addNotes | Adds notes to a record |
We've covered delink-related records with a detailed example in this post. Also, you can check out this post for a combined action that delinks a related record and adds notes.
Scenario 4
Let's say you want to handle data between two applications and make Ajax calls from a widget. There might be multiple HTTP methods that you can use to either retrieve, post, delete, or update data between applications.
In such a case, the API you can use is:
ZOHO.CRM.HTTP.delete | Invokes HTTP delete |
ZOHO.CRM.HTTP.get | Invokes HTTP get |
And there are many more APIs supported by Zoho CRM JS SDK that helps you perform a variety of functions.
We hope you found this information useful. Keep following this space for more info!
SEE ALSO
Access your files securely from anywhere
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
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
New to Bigin?
Topic Participants
Nanditha Somasundaram Somasundaram
Newjoinee
Sunderjan Siddharth
Developer
Sticky Posts
Kaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideClient Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! CommandsExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedExtension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomes
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho Campaigns Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー