This document will help you sync your HRMS software with Zoho Cliq.
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/authStep 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
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
- }