Integrating Cliq with your HRMS software

Integrating Cliq with your HRMS software

This document will help you sync your HRMS software with Zoho Cliq.

Establishing authentication using Zoho Oauth

Authentication is crucial for secure data interactions, and Zoho OAuth offers a standardized protocol. So, before you can connect your HRMS software with Zoho Cliq, you must establish authentication between the two apps. 
To establish authentication with Zoho Cliq, please follow the steps in our API documentation.
First, you will need to establish an authentication connection between Zoho Cliq and your HRMS software. Zoho Cliq's Rest APIs follow the OAuth 2.0 protocol to authorize and authenticate requests. Each API request must include an OAuth token to receive a success response. All API requests must be made over HTTPS. Calls made over plain HTTP and using API without authentication will also fail.
Note: You must use domain-specific Zoho Cliq URL to generate and refresh tokens.

OAuth Token generation

To generate an OAuth token, follow these steps:

Step 1: Generate Client ID and Client Secret

Register your application as a new client by accessing this website:
Note: Make sure to use domain-specific Zoho Accounts URL while registering
  1. Click on Add Client ID and enter the following :
    1. Client Name
    2. Client Domain
    3. Authorized redirect URIs
  2. Click Create
Upon providing the necessary registration details, you will be given a set of OAuth credentials known as the client ID and client secret exclusive for your application. These credentials will be known to both Zoho and your application.

Step 2: Authorization by generating a grant token

Redirect the user to the authorization URL and authorization will be done when the user grants access to the "user consent" page. The authorization URL is: https://accounts.zoho.com/oauth/v2/auth

Step 3: Generating Access and Refresh Token

The value for the code parameter obtained in the response of Step 2 should be used to generate the access and refresh token. 

APIs

These are the different APIs you may need for use cases to sync your HRMS software
  1. Add User in Zoho Cliq via API
  2. Update User Fields in Zoho Cliq via API for a Particular User
  3. Activate & Deactivate a Particular User in Zoho Cliq via API
  4. Add Members to Team
  5. Remove Members from Team
  6. Add Member to Department
  7. Remove Member from Department

Add User in Zoho Cliq via API : You can use this API to add one or multiple users in Zoho Cliq.
Update User Fields in Zoho Cliq via API for a Particular User : For updating user fields in Zoho Cliq for a specific user, refer to the Update Users API documentation. Ensure to pass the unique name of custom fields as the key name with corresponding values. To obtain the unique name of custom fields, use the Retrieve Users-Field API.
Note:
  1. For date and dropdown type custom fields, follow the specified formats:
  2. Date: Time should be in milliseconds (e.g., "dob": 1640592764071).
  3. Dropdown: Use the option ID assigned to an option in the dropdown field. Use the retrieve userfield API to get the list of available options.
Activate & Deactivate a particular user in Zoho Cliq via API : To activate or deactivate a user in Zoho Cliq, use the following API with the specified URL, method, and request body:
  1. URL : /api/v2/users/{user_id}
  2. Method : PUT
  3. Scope : ZohoCliq.Users.UPDATE
  4. Request Body:
  1. {
  2. "is_active": false/true
  3. }
Team - Add Members/ Remove Members : Use these APIs to add/ remove members from a team.
Department - Add Members/ Remove Members: Use these APIs to add/ remove members from a department.

    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 CRM Training
      Redefine the way you work
      with Zoho Workplace

        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 CRM Training

          Create, share, and deliver

          beautiful slides from anywhere.

          Get Started Now


            Zoho Sign now offers specialized one-on-one training for both administrators and developers.

            BOOK A SESSION








                                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.




                                    Manage your brands on social media

                                      Zoho Desk Resources

                                      • Desk Community Learning Series


                                      • Digest


                                      • Functions


                                      • Meetups


                                      • Kbase


                                      • Resources


                                      • Glossary


                                      • Desk Marketplace


                                      • MVP Corner


                                      • Word of the Day


                                        Zoho Marketing Automation

                                          Zoho Sheet Resources

                                           

                                              Zoho Forms Resources


                                                Secure your business
                                                communication with Zoho Mail


                                                Mail on the move with
                                                Zoho Mail mobile application

                                                  Stay on top of your schedule
                                                  at all times


                                                  Carry your calendar with you
                                                  Anytime, anywhere




                                                        Zoho Sign Resources

                                                          Sign, Paperless!

                                                          Sign and send business documents on the go!

                                                          Get Started Now




                                                                  Zoho TeamInbox Resources



                                                                          Zoho DataPrep Resources



                                                                            Zoho DataPrep Demo

                                                                            Get a personalized demo or POC

                                                                            REGISTER NOW


                                                                              Design. Discuss. Deliver.

                                                                              Create visually engaging stories with Zoho Show.

                                                                              Get Started Now







                                                                                            You are currently viewing the help articles of Sprints 1.0. If you are a user of 2.0, please refer here.

                                                                                            You are currently viewing the help articles of Sprints 2.0. If you are a user of 1.0, please refer here.



                                                                                                  • Related Articles

                                                                                                  • Integrating Telephony with Cliq

                                                                                                    Integrating Telephony with Cliq will save the time and effort that you put into choosing and setting up a phone system for your business. Smart suggestions in Cliq, auto-detects the phone number shared in a conversation and provides you with an ...
                                                                                                  • Software and hardware requirements for running Cliq

                                                                                                    Component                             Requirement Computer and processor Minimum 1.1 GHz or faster, 2 core Memory 4.0 GB RAM Hard disk 3.0 GB of available disk space One on one call bandwidth requirements Audio call. - 5 Kbps | 40 Kbps Video call  ...
                                                                                                  • What is a Cliq network and how to set it up?

                                                                                                    Cliq network is a dedicated space to collaborate with your external business stakeholders such as partners, vendors, agencies, consultants, volunteers and more. It equips you with an extensive set of configurable permissions to facilitate controlled ...
                                                                                                  • How to create a thread in Cliq?

                                                                                                    Enabling threads in Cliq To enable Threads navigate to the Permissions section of threads by clicking on the channel icon and selecting Permissions or select Channel Info made available in Actions menu in the channel. Click on Reply Modes dropdown ...
                                                                                                  • Orchestly for Zoho Cliq

                                                                                                    Zoho Cliq is a team communication application that simplifies collaboration and promotes organized conversations in the workplace. Benefits of the Extension By integrating Zoho Cliq with Qntrl, users can create new jobs and work on them in Qntrl, ...
                                                                                                    Wherever you are is as good as
                                                                                                    your workplace

                                                                                                      Resources

                                                                                                      Videos

                                                                                                      Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                      eBooks

                                                                                                      Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                      Webinars

                                                                                                      Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                      CRM Tips

                                                                                                      Make the most of Zoho CRM with these useful tips.



                                                                                                        Zoho Show Resources