Kaizen #22 - Connections in Zoho CRM
Hello everyone!
Welcome back to another post in the Kaizen series!
This week, we will discuss Connections in Zoho CRM.
In this post, we will discuss the following:
- What are connections?
- Authentication types
- Creating a connection
- Using a connection
1. What are Connections?
A Connection (or a connector) is a simple authentication mechanism to connect your Zoho CRM account with a third-party app.
Zoho provides default integration support to a wide range of apps like core Google services (Contacts, Calendar, and Google Ads) and Microsoft software (MS Office, MS Outlook, etc).
However, there is no default integration with third party services like PandaDoc, SignEasy etc,. In these cases, you can use a connector to expand Zoho's third-party support. Connectors use the OAuth 2.0 or other authentication types to facilitate this integration.
You can use connections to invoke any third-party apps' REST APIs and get access to the authenticated data through your functions or widgets.
Zoho provides more than 20 connections to the most popular third-party apps, out of the box. You can also create your own connection and integrate your app with Zoho CRM.
2. Authentication types
Since different services have different methods of authentication for their service, Connections are equipped with four different modes of authentication.
a. Basic Authentication
b. API Key
c. OAuth 1.0
d. OAuth 2.0
a. Basic Authentication
This is the authentication method where the user's username and password are sent in the header, form data, or the query string in the format username:password. This method uses the Base64 encoding standard to encode the username and password.
b. API Key
This is a token that the client provides that you can send in the query string or in the header. The API key is unique to every user and stays the same for that user as long as the user uses the service.
c. OAuth 1.0
This method uses a Request Token and an Access Token to get access to the resources on the resource server. The access token does not expire until the user revokes it.
d. OAuth 2.0
This method provides an app limited access by providing an access token only to specific resources. The access token is valid only for an hour.
3. Creating a Connection
To create a new connection,
- Go to Setup > Developer Space > Connections.
- Click Get Started. The Create Connection page opens.
- The Pick your Service tab lists all the connections that are already available. Choose the one that meets your needs.
- If any third-party app is not listed under this tab, you can add a new service under the Custom Service tab.
- For already existing services (under the Pick Your Service tab),
a. Select the service of your choice.
b. Enter the details of the connection such as the name and choose the scope you require from the list.
c. Click Create and Connect. The below image shows a sample connection created for the YouTube app, and you can use the code shown in the box to invoke the YouTube APIs.
- For a new service (services not listed under the Pick Your Service tab),
a. Click the Custom Service tab.
b. Enter the name of the service and choose the authentication type that the third-party service supports.
c. For services that use the OAuth1.0 or OAuth2.0 protocol, enter the following details:
Client ID and Secret you obtained from the third-party service.
The URLs to obtain the request token and the access token (OAuth1.0).
The URLs to obtain the access token and refresh token (OAuth 2.0).
You must obtain these details from the third-party service's documentation.
The below image shows a sample connection created for the third-party service "SignEasy".
- Enter the name of the connection and the required scope.
- Click Create and Connect.
- The connection will be created and the summary will be displayed.
The system also displays the code you must use in a function to invoke the connection.
The below image shows the sample connection created for the third-party service "SignEasy". You can use the code in the box to use the APIs of SignEasy.
- Where,
url: The URL that you can obtain from the third-party service.
type: The HTTP request method (GET, POST, PUT, or DELETE) that the request performs.
parameters: The parameters that the function uses to replace the dynamic values present in the API with user-specific values.
4. Using a Connection
After creating a connection, you can use them in functions to invoke them.
Let us consider a case where you want to send out newsletters through a MailChimp campaign to the contacts stored in Zoho CRM. Before you can send them the newsletters, you want to obtain their consent through a consent form stored in Google Drive.
Here, you must establish a connection between MailChimp and Google Drive and have the consent form as a button in the View page of the Contacts module in CRM.
You can choose to place this widget as a button in the View page of a contact. When the CRM user (an agent) clicks this button, the Consent form widget opens where the agent fills the details of the user.
This triggers the function where an email is sent to the customer. When the customer grants consent, the details of that contact are added to the MailChimp campaign list.
Simply put, you must
a. Establish a connection between Google Drive and MailChimp.
b. Write a function to call the APIs of both these apps.
c. Make the function available as an API.
d. Create a widget and invoke the function.
Let us now see these steps in detail.
a. Establish a connection between Google Drive and MailChimp
Follow the steps in the "Create a Connection" section, and create connections for Google Drive and MailChimp.
b. Write the function code
- Go to Setup > Developer Space > Functions > +New Function.
- Enter details like the function name, display name, description, and choose the function category (Standalone, in our case).
- Write the code in the console as shown below. You can find the code as an attachment to this post.
What does this sample function do?
a. Invokes the MailChimp API.
b. Checks for the Campaign ID.
c. Checks for the email address. If the email already exists on the campaign list, throws the message "The member has already subscribed to the newsletter." Otherwise, adds the email to the campaign list.
d. Invokes the Google Drive API to get the link of the Consent form.
e. If the consent form exists on Google Drive, sends the form to the email address.
e. If the form does not exist, throws the error "No document found".
- This function takes the following parameters
listId (string) - The Campaign ID from MailChimp,
emailAddress (string) - The email ID of the contact you want to send the newsletter to,
extraDetails (string) - To capture any extra information about the contact after they grant consent such as the mobile number, address etc. - Click Save and Execute. Provide the listId, emailAddress, and extraDetails to check if the function works as expected.
- Click Close.
c. Make the function available as an API
- Go to Setup > Developer Space > Functions.
- Choose the required function and click the Settings icon. Select REST API.
- Enable the OAuth2.0 and API key sliders and click Save.
- The function is now available as an API. You can use the URL as a webhook to trigger the function or use the API name of the function in your code to trigger it.
For more details about functions, refer to this post.
d. Create a widget and invoke the function
Since the function is now available as an API, you can use it in any widget and trigger the function based on your needs.
The HTML and the script for the below consent form is attached to this post.
You can also write your own implementation of the widget. Refer to this page to know how.
What does the sample widget code do?
a. The HTML renders the widget.
b. When the user hits the "Subscribe" button, the script invokes the connection and calls the above function (4.b.3) via JavaScript.
We hope you found this post useful. Stay tuned for more!
Cheers!
Access your files securely from anywhere
New to Zoho Recruit?
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
Shylaja S
Matt Beck
Praveen Sankar
Sticky Posts
Kaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Celebrating 200 posts of Kaizen! Share your ideas for the milestone post
Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQsKaizen #193: Creating different fields in Zoho CRM through API
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Client 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! Commands
New to Zoho TeamInbox?
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
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セミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
How to create auto populate field based on custom module in Zoho CRM?
Hello, i'm still new to Zoho CRM and work as administrator in my company. Currently, I'm configuring layout for Quotes Module. So, the idea is, I've created a read-only field in Quotes called "Spec". I want this field automatically filled with Specificationwebinar registration confirmation are landing in SPMA folders
I am trialing zoho webinar and do not have access to custom domains. When I test user registrations, they are working but the resulting confirmation email is landing in a spam folder. How can I avoid this?Making digital signatures accessible to all: Introducing accessibility controls in Zoho Sign
Hi there! At Zoho Sign, we are committed to building an inclusive digital experience for all our users. As part of our ongoing efforts to align with Web Content Accessibility Guidelines (WCAG), we’re updating the application with support that will goIs there a way to set Document Owner/Sender via the API
When sending requests for zoho sign, it would seem zoho uses the id of the person that created the zoho api cred to determine the owner_id, is there a way to set a default for this?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'tDelegates should be able to delete expenses
I understand the data integrity of this request. It would be nice if there was a toggle switch in the Policy setting that would allow a delegate to delete expenses from their managers account. Some managers here never touch their expense reports, andAdd Save button to Expense form
A save button would be very helpful on the expense form. Currently there is a Save and Close button. When we want to itemize an expense, this option would be very helpful. For example, if we have a hotel expense that also has room service, which is aMultiple organizations under Zoho One
Hello. I have a long and complicated question. I have a Zoho One account and want to set it up to serve the needs of 6 organizations under the same company. Some of the Zoho One users need to be able to work in more than 1 organization’s CRM and otherIMAP Server not responding.
Trying to connect a phone via IMAP and getting "imap.zoho.com not responding." Is the server down, for maintenance or otherwise? I've tried this on two different devices and got the same error on both.Error AS101 when adding new email alias
Hi, I am trying to add apple@(mydomain).com The error AS101 is shown while I try to add the alias.Unbundle feature for composite items
We receive composite items from our vendors and sell them either individually or create other composite items out of them. So, there is a lot of bundling and unbundling involved with our composite items. Previously, this feature was supported in formRegarding the integration of Apollo.io with Zoho crm.
I have been seeing for the last 3 months that your Apollo.io beta version is available in Zoho Flow, and this application has not gone live yet. We requested this 2 months ago, but you guys said that 'we are working on it,' and when we search on GoogleOpen filtered deals from campaign
Do you think a feature like this would be feasible? Say you are seeing campaign "XYZ" in CRM. The campaign has a related list of deals. If you want to see the related deals in a deal view, you should navigate to the Deals module, open the campaign filter,How do you print a refund check to customer?
Maybe this is a dumb question, but how does anyone print a refund check to a customer? We cant find anywhere to either just print a check and pick a customer, or where to do so from a credit note.MTD SA in the UK
Hello ID 20106048857 The Inland Revenue have confirmed that this tax account is registered as Cash Basis In Settings>Profile I have set ‘Report Basis’ as “Cash" However, I see on Zoho on Settings>Taxes>Income Tax that the ‘Tax Basis’ is marked ‘Accrual'workflow not working in subform
I have the following code in a subform which works perfectly when i use the form alone but when i use the form as a subform within another main form it does not work. I have read something about using row but i just cant seem to figure out what to changeFetch data from another table into a form field
I have spent the day trying to work this out so i thought i would use the forum for the first time. I have two forms in the same application and when a user selects a customer name from a drop down field and would like the customer number field in theZoho Creator as LMS and Membership Solution
My client is interested in using Zoho One apps to deploy their membership academy offer. Zoho Creator was an option that came up in my research: Here are the components of the program/offer: 1. Membership portal - individual login credentials for eachRecord comment filter
Hi - I have a calendar app that we use to track tasks. I have the calendar view set up so that the logged in user only sees the record if they are assigned to the task. BUT there are instances when someone is @ mentioned in the record when they are notHow to View Part Inventory and Warehouse Location When Creating a Work Order in Zoho FSM
Hi everyone, We’re currently setting up Zoho FSM and would like to improve how our team selects parts when creating a Work Order. Right now, when we add a part or item to a Work Order, we can select it from our Zoho Inventory list but we don’t see anyFSM too slow today !!
Anybody else with problem today to loading FSM (WO, AP etc.)?CRM x WorkDrive: File storage for new CRM signups is now powered by WorkDrive
Availability Editions: All DCs: All Release plan: Released for new signups in all DCs. It will be enabled for existing users in a phased manner in the upcoming months. Help documentation: Documents in Zoho CRM Manage folders in Documents tab Manage filesNot able to Sign In in Zoho OneAuth in Windows 10
I recently reset my Windows 10 system, after the reset when I downloaded the OAuth app and tried to Sign In It threw an error at me. Error: Token Fetch Error. Message: Object Reference not set to an instance of an object I have attached the screenshotMapping a custom preferred date field in the estimate with the native field in the workorder
Hi Zoho, I created a field in the estimate : "Preferred Date 1", to give the ability to my support agent to add a preferred date while viewing the client's estimate. However, in the conversion mapping (Estimate to Workorder), I'm unable to map my customRuning RPA Agents on Headless Windows 11 Machines
Has anyone tried this? Anything to be aware of regarding screen resolution?The sending IP (136.143.188.15) is listed on spamrl.com as a source of spam.
Hi, it just two day when i am using zoho mail for my business domain, today i was sending email and found that message "The sending IP (136.143.188.15) is listed on https://spamrl.com as a source of spam" I hope to know how this will affect the deliveryDelegates - Access to approved reports
We realized that delegates do not have access to reports after they are approved. Many users ask questions of their delegates about past expense reports and the delegates can't see this information. Please allow delegates see all expense report activity,Split functionality - Admins need ability to do this
Admins should be able to split an expense at any point of the process prior to approval. The split is very helpful for our account coding, but to have to go back to a user and ask them to split an invoice that they simply want paid is a bit of an inWhat is a a valid JavaScript Domain URI when creating a client-based application using the Zoho API console?
No idea what this is. Can't see what it is explained anywhere.Is there a way to request a password?
We add customers info into the vaults and I wanted to see if we could do some sort of "file request" like how dropbox offers with files. It would be awesome if a customer could go to a link and input a "title, username, password, url" all securely and it then shows up in our team vault or something. Not sure if that is safe, but it's the best I can think of to be semi scalable and obviously better than sending emails. I am open to another idea, just thought this would be a great feature. Thanks,Single Task Report
I'd like a report or a way to print to PDF the task detail page. I'd like at least the Task Information section but I'd also like to see the Activity Stream, Status Timeline and Comments. I'd like to export the record and save it as a PDF. I'd like theAuto-response for closed tickets
Hi, We sometimes have users that (presumably) search their email inbox for the last correspondence with us and just hit reply - even if it's a 6 month old ticket... - this then re-opens the 6 month old ticket because of the ticket number in the email's subject. Yes, it's easy to 'Split as new Ticket', but I'd like something automated to respond to the user saying "this ticket has already been resolved and closed, please submit a new ticket". What's the best way to achieve this? Thanks, EdHow to Push Zoho Desk time logged to Zoho Projects?
I am on the last leg of my journey of finally automating time tracking, payments, and invoicing for my minutes based contact center company - I just have one final step to solve - I need time logged in zoho desk to add time a project which is associatedCannot access KB within Help Center
Im working with my boss to customize our knowledge base, but for some reason I can see the KB tab, and see the KB categories, but I cannot access the articles within the KB. We have been troubleshooting for weeks, and we have all permissions set up, customersExport to excel stored amounts as text instead of numbers or accounting
Good Afternoon, We have a quarterly billing report that we generate from our Requests. It exports to excel. However if we need to add a formula (something as simple as a sum of the column), it doesn't read the dollar amounts because the export storeswhy my account is private?
when i post on zohodesk see only agent onlyGetting ZOHO Invoice certified in Portugal?
Hello, We are ZOHO partners in Portugal and here, all the invoice software has to be certified by the government and ZOHO Invoice still isn´t certified. Any plans? Btw, we can help on this process, since we have a client that knows how to get the software certified. Thank you.Show/ hide specific field based on user
Can someone please help me with a client script to achieve the following? I've already tried a couple of different scripts I've found on here (updating to match my details etc...) but none of them seem to work. No errors flagged in the codes, it just500 Internal Server Error
I have been trying to create my first app in Creator, but have been getting the 500: Internal Server Error. When I used the Create New Application link, it gave me the error after naming the application. After logging out, and back in, the application that I created was in the list, but when I try to open it to start creating my app, it gives me the 500: Internal Server Error. Please help! Also, I tried making my named app public, but I even get the error when trying to do that.Client Script | Update - Client Script Support For Portals
Dear All! We are excited to announce the highly anticipated feature: Client Script support for Portals. We understand that many of you have been eagerly awaiting this enhancement, and we are pleased to inform you that this support is now live for allNext Page