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
- Click on Add Client ID and enter the following :
- Client Name
- Client Domain
- Authorized redirect URIs
- 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
- Add User in Zoho Cliq via API
- Update User Fields in Zoho Cliq via API for a Particular User
- Activate & Deactivate a Particular User in Zoho Cliq via API
- Add Members to Team
- Remove Members from Team
- Add Member to Department
- 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:
- For date and dropdown type custom fields, follow the specified formats:
- Date: Time should be in milliseconds (e.g., "dob": 1640592764071).
- 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:
- URL : /api/v2/users/{user_id}
- Method : PUT
- Scope : ZohoCliq.Users.UPDATE
- Request Body:
- {
- "is_active": false/true
- }
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.
Access your files securely from anywhere
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:
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Writer?
Create. Review. Publish.
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?
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
Integrating Telephony with Zoho Cliq
Zoho Cliq's Phone system allows you to integrate with your favourite PBX provider via Zoho Telephony to make or receive sales and support calls. Before Integrating with Zoho Cliq, you will have to set up Zoho telephony via one of the following apps: ...Cliq Cart
Cliq Cart is a nifty e-commerce tool crafted for your organization and teams to seamlessly browse, purchase, sell, and even host auctions without leaving Zoho Cliq. Whether you're searching for essential office supplies, showcasing your latest ...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 ...Live events in Zoho Cliq
Live events in Zoho Cliq help you host and broadcast events to a large audience virtually. There are four ways by which you can schedule a live event: Quick actions( + icon next to search bar) Schedule Meeting under remote work. Live events under ...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 ...
New to Zoho LandingPage?
Zoho LandingPage Resources