Kaizen #106 - Functions and Invoke URLs - Part 2

Kaizen #106 - Functions and Invoke URLs - Part 2

Hello everyone! Welcome to Kaizen #106.
In continuation to our last post, today, we will discuss invoke URLs in functions, how they are different from integration tasks, and how authentication works for them.

What are invokeURL tasks?

invokeUrl task is a task designed to trigger HTTP API endpoints of Zoho apps or any external services. invokeUrl makes the authorization part much easier by setting up connectors.

How are invoke URLs authenticated?

Using Connections.
Connections allow you to connect to various third-party apps or other Zoho services. Connections essentially use the OAuth 2.0 protocol. It abstracts the entire OAuth2.0 authorization flow and keeps your code simple, clean, and crisp.
If you set up a connection once, and authorize it once, you can make API calls to and from the external system and Zoho CRM.
You can create a single connection for your org and other users of your org can use the same connection by authenticating it with their credentials. Other users of your org can use your connection. In such cases, your connection will appear as a "shared connection" in their accounts.
Similarly, if you use your credentials to authenticate a connection created by some other user, it will be listed under the "shared connections" of your account.
For more details on types of connections, refer to this page.

Default Services

Zoho CRM has integrated with various third-party apps and they are listed under Default Services. All you have to do is
  1. Go to Setup > Developer Space > Connections > Create Connection.
  2. Under "Pick your service", choose the app you want to connect to. Here, I have chosen Gsheet.
  3. Click Create Connection.
  4. Specify the Connection Name and choose the scopes from the list. Note that this will vary based on the service you choose.

  5. Click Create and Connect.
  6. You will be redirected to a screen asking for your consent to connect to the service.
  7. Provide your login credentials.
  8. Click Connect. You will be redirected to Zoho Flow's authentication page, asking for your consent to connect to the service and redirect you to the service's login page.

  9. On the service's login page, provide your credentials and login.
  10. The service shows a pop up explaining the data that Zoho flow will use through the connection.

  11. Click Allow.
  12. The connection will be created in Zoho CRM.

  13. The sample code contains the snippet of the invoke URL you must use in your function to use the Gsheet's endpoints.
By simply using the connection name in your code, you can connect to third-party apps without worrying about token generation or configuration.

Components of the invoke URL

url - The third party's API endpoint you want to access.
type - The type of API call it is going to be. Supports GET, POST, PUT and DELETE.
parameters - The body of the request.
connection - The name of the connection you want to use.
For more details on invoke URL task, refer to this page.

Custom Service

Use this option when the service you want to connect to is not listed under "Default Services".
To create a custom service and connect to it, you must give the details of the service like its name, authorization type, and other attributes, and take care of token generation.


Differences between integration tasks and invoke URLs

Integration Tasks
Invoke URLs
API wrappers to Zoho APIs. Can be called just like built-in functions.
HTTP requests that are triggered explicitly.
All integration task actions are triggered under the admin’s authorization.
All invokeUrl actions that are triggered pertain to the user that authorized the connection.

Here is a sample of a function using invoke URL and the connection named "mine".

headermap = map();
headermap.put("this goes in the header", "value");
paramMap = map();
paramMap.put("this goes in the body", "body");
info paramMap;
response = invokeUrl [
type: POST
headers: headermap
content-type: "application/json"
parameters: paramMap.toString()
connection: "mine"
];
info response;
return "";

Here is the response.


As you can see, as the connection is already authenticated using OAuth2.0, the connection directly supplies the access token.
We hope you found this post useful. Let us know what you think in the comments, or email us at support@zohocrm.com.

Cheers!




    Access your files securely from anywhere








                            Zoho Developer Community




                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                  • Ask the Experts



                                                            • Sticky Posts

                                                            • Kaizen #217 - Actions APIs : Tasks

                                                              Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.
                                                            • Kaizen #216 - Actions APIs : Email Notifications

                                                              Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are
                                                            • Kaizen #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 achieved
                                                            • Kaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script

                                                              Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.
                                                            • Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI

                                                              Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the


                                                            Manage your brands on social media



                                                                  Zoho TeamInbox Resources



                                                                      Zoho CRM Plus Resources

                                                                        Zoho Books Resources


                                                                          Zoho Subscriptions Resources

                                                                            Zoho Projects Resources


                                                                              Zoho Sprints Resources


                                                                                Qntrl Resources


                                                                                  Zoho Creator Resources



                                                                                      Zoho CRM Resources

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner







                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources

                                                                                              Zoho Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ




                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方







                                                                                                              • Recent Topics

                                                                                                              • Unable to explore desk.zoho.com

                                                                                                                Greetings, I have an account with zoho which already has a survey subscription. I would like to explore desk.zoho.com, but when I visit it while logged in (https://desk.zoho.com/agent?action=CreatePortal) I just get a blank page. I have tried different
                                                                                                              • Offline support for mobile app

                                                                                                                Accessing your files and folders from your mobile devices is now quicker and simpler, thanks to the power of offline support. Whether on an Android or iOS device, you can use the Offline function to save files and folders, so you can review them even
                                                                                                              • Zoho Desk KB article embedded on another site.

                                                                                                                We embed KB articles from Zoho Desk on another site (our application). When opening the article in a new tab, there is no issue, but if we choose lightbox, we are getting an error "To protect your security, help.ourdomain.com will not allow Firefox to
                                                                                                              • List of packaged components and if they are upgradable

                                                                                                                Hello, In reference to the article Components and Packaging in Zoho Vertical Studio, can you provide an overview of what these are. Can you also please provide a list of of components that are considered Packaged and also whether they are Upgradable?
                                                                                                              • Does Attari Messaging app have Bot option and APIB

                                                                                                                Hi, Does Attari also have Bot and API as we use in WhatsApp??
                                                                                                              • How to add application logo

                                                                                                                I'm creating an application which i do not want it to show my organization logo so i have changed the setting but i cannot find where to upload/select the logo i wish to use for my application. I have seen something online about using Deluge and writing
                                                                                                              • Zoho Analytics Regex Support

                                                                                                                When can we expect full regex support in Zoho Analytics SQL such as REGEXP_REPLACE? Sometimes I need to clean the data and using regex functions is the easiest way to achieve this.
                                                                                                              • Change of Blog Author

                                                                                                                Hi, I am creating the blog post on behalf of my colleague. When I publish the post, it is showing my name as author of the post which is not intended and needs to be changed to my colleague's name. How can I change the name of the author in the blogs?? Thanks, Ramanan
                                                                                                              • Details & Limitations of the Free Forever Plan

                                                                                                                I cannot find any comparison/details about the Free Forever Plan. Can you please publish details of what are its limitations?
                                                                                                              • how to differentiate if whatsapp comes from certain landing page?

                                                                                                                I create a Zobot in SalesIQ to create a Whatsapp bot to capture the lead. I have 2 landing pages, one is SEO optimized and the other want is optimized for leads comes from Google Ads. I want to know from which landing page this lead came through WhatsApp
                                                                                                              • How to record company set up fees?

                                                                                                                Hi all, We are starting out our company in Australia and would appreciate any help with setting up Books accounts. We paid an accountant to do company registration, TFN, company constitution, etc. I heard these all can be recorded as Incorporation Costs, which is an intangible asset account, and amortised over 5 years. Is this the correct way to do it under the current Australian tax regulations? How and when exactly should I record the initial entry and each year's amortasation in Books? Generally
                                                                                                              • Show Payment terms in Estimates

                                                                                                                Hi,  we are trying to set up that estimates automatically relates payment terms for the payment terms we introduced on Edit contact (Field Payment terms).  How can it be done? Our aim is to avoid problems on payment terms introduced and do not need to introduce it manually on each client (for the moment we are introducing this information on Terms and Conditions.  Kind Regards, 
                                                                                                              • When dispatched to crew, assigning lead missing

                                                                                                                Hello, For the past two or three weeks, whenever an officer assigns Service Appointment to a team, the lead person is missing from the assigned service list. Therefore, we have to reschedule the SA and then the lead person becomes visible in the assigned
                                                                                                              • I want to transfer the project created in this account to another account

                                                                                                                Dear Sir I want to transfer the project created in one account to another account
                                                                                                              • Custom Bulk Select Button

                                                                                                                Zoho CRM offers the ability to select multiple records and invoke a Custom Button This functionality is missing from Recruit Currently we can only add buttons in the detail page and list But we cannot select Multiple Records and invoke a function with
                                                                                                              • Power of Automation :: Smart Ticket Management Between Zoho Desk and Projects

                                                                                                                Hello Everyone, A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automate
                                                                                                              • BUG - Google Business Buttons - Add a button to GBP Post

                                                                                                                I am experiencing an issue with the "Add a button" feature when creating posts for my Google Business Profile (GBP) through Zoho Social. When I schedule or publish a GBP post and include a call-to-action button with a specific URL, the post itself publishes
                                                                                                              • Do you have software like Windows software?

                                                                                                                We want swadeshi software
                                                                                                              • Support for Custom Fonts in Zoho Recruit Career Site and Candidate Portal

                                                                                                                Dear Zoho Recruit Team, I hope you're doing well. We would like to request the ability to use custom fonts in the Zoho Recruit Career Site and Candidate Portal. Currently only the default fonts (Roboto, Lato, and Montserrat) are available. While these
                                                                                                              • Trying to export a report to Excel via a deluge script

                                                                                                                I have this code from other posts but it gives me an error of improper statement, due to missing ; at end of line or incomplete expression. Tried lots of variations to no avail. openUrl(https://creatorapp.zoho.com/<username>/<app name>/XLSX/#Report:<reportname>,"same
                                                                                                              • Need help to create a attach file api

                                                                                                                https://www.zoho.com/crm/developer/docs/api/v8/upload-attachment.html Please help me to create it... It's not working for while. Do you have some example?
                                                                                                              • Export view via deluge.

                                                                                                                Hi, Is it possible to export a view (as a spreadsheet) via deluge? I would like to be able to export a view as a spreadsheet when a user clicks a button. Thanks     
                                                                                                              • Possible to generate/download Quote PDF using REST API?

                                                                                                                See title. Is there any way after a quote has been created to export to a PDF using a specified template and then download it? Seems like something that should be doable. Is this not supported in the API v2.0?
                                                                                                              • Creating an invoice to be paid in two installments?

                                                                                                                Hi there, I own a small Photographic Services business and have not been able to find a way to fit my billing system into Zoho, or any other Accounting software. The way my payments work is: 1. Customer pays 50% of total price of service to secure their
                                                                                                              • Bug in allowing the user to buy out of stock items

                                                                                                                Hi i want to allow the user to buy out of stock items, according to the commerce documentation if i disable Restrict "Out of stock" purchases it will, but it doesnt work, so i want to know if it had any relation with zoho inventory, and if theres any
                                                                                                              • Replace Lookup fields ID value with their actual name and adding inormation from subforms

                                                                                                                Hi everyone,  I wanted to see if someone smarter than me has managed to find any solutions to two problems we have. I will explain both below.  To start we are syncing data from Zoho CRM to Zoho Analytics and I will use the Sales Order module when giving
                                                                                                              • Can a Zoho Sites page be embedded into another website (outside Zoho)

                                                                                                                Hi All, We have a request from a client - they'd like to take one of our information pages created in Zoho Sites and embed it into their own website? I was told through an email with Zoho that this was possible >>Thank you for your patience regarding
                                                                                                              • Bug in allowing the user to buy out of stock items

                                                                                                                Hi i want to allow the user to buy out of stock items, according to the commerce documentation if i disable Restrict "Out of stock" purchases it will, but it doesnt work, so i want to know if it had any relation with zoho inventory, and if theres any
                                                                                                              • Transition Criteria Appearing on Blueprint Transitions

                                                                                                                On Monday, Sept. 8th, the Transition criteria started appearing on our Blueprints when users hover over a Transition button. See image. We contacted Zoho support because it's confusing our users (there's really no reason for them to see it), but we haven't
                                                                                                              • Zoho CRM Sales Targets for Individual Salespeople

                                                                                                                Our organistion has salespeople that are allocated to different regions and have different annual sales targets as a result. I am building an CRM analytics dashboard for the sales team, which will display a target meter for the logged in salesperson.
                                                                                                              • Transfer all Related Data to new Account Owner

                                                                                                                Currently when I change the account Owner I only see the option to change only the open deals But I want the new account owner to take over all the related modules and all the deal stages Is it not possible right now? Am I missing something? Do I really
                                                                                                              • How to Calculate MTTR (Mean Time to Resolve)

                                                                                                                We want to calculate MTTR (Mean Time to Resolve) in our Zoho Analytics report under Tickets. Currently, we are using the following fields: Ticket ID Ticket Created Time Ticket Closed Time Ticket On Hold Time We are planning to calculate MTTR (in days)
                                                                                                              • How to export project tasks, including the comments

                                                                                                                Hi, how can I export the project tasks, whereby I can also see the comments associated to a specific task? The use-case is that often we use comments to discuss or update a task related ideas. I would like to export the tasks, where we can also see the
                                                                                                              • Does Zoho Sheet Supports https://n8n.io ?

                                                                                                                Does Zoho Sheet Supports https://n8n.io ? If not, can we take this as an idea and deploy in future please? Thanks
                                                                                                              • Bigin Android app update: User management

                                                                                                                Hello everyone! In the most recent Bigin Android app update, we have brought in support for the 'Users and Controls' section. You can now manage the users in your organization within the mobile app. There are three tabs in the 'Users and Controls' section:
                                                                                                              • Share records with your customers and let them track their statuses in real time.

                                                                                                                Greetings, I hope everyone is doing well! We're excited to introduce the external sharing feature for pipeline records. This new enhancement enables you to share pipeline records with your customers via a shareable link and thereby track the status of
                                                                                                              • Live webinar: Discover Zoho Show: A complete walkthrough

                                                                                                                Hello everyone, We’re excited to invite you to our upcoming live webinar, Discover Zoho Show: A Complete Walkthrough. Whether you’re just getting started with Show or eager to explore advanced capabilities, this session will show you useful tips and features
                                                                                                              • Deal Stage component/widget/whatever it is... event

                                                                                                                Deal Stages I am trying to access the event and value of this component. I can do it by changing the Stage field but users can also change a Deal Stage via this component and I need to be able to capture both values. Clicking on 'Verbal' for instance,
                                                                                                              • Create advanced slideshows with hybrid reports using Zoho Projects Plus

                                                                                                                Are your quarterly meetings coming up? It’s time to pull up metrics, generate reports, and juggle between slides yet again. While this may be easier for smaller projects, large organizations that run multiple projects may experience the pressure when
                                                                                                              • Add an option to disable ZIA suggestions

                                                                                                                Currently, ZIA in Zoho Inventory automatically provides suggestions, such as sending order confirmation emails. However, there is no way to disable this feature. In our case, orders are automatically created by customers, and we’ve built a custom workflow
                                                                                                              • Next Page