Setup
Connect to your Zoho Recruit app for OAuth.
To setup your Zoho Recruit app in Cobalt for OAuth, you will need the following credentials from your Zoho Developer Console:
- Client ID
- Client Secret
Pre-requisites
- Zoho Developer Console. You can create one here.
Required Settings
- Mandatory Scopes
- ZohoRecruit.users.READ
Creating an app in Zoho Recruit
To create a Zoho Recruit app and acquire the above mentioned credentials, please follow the steps mentioned below:
- Log in to your Zoho Developer Console.
- Click on the
+ Add Client
button in the right and selectServer-based Applications
button.
- Enter the Client Name for your application and add a Homepage URL.
- Go to your
Apps catalog
in Cobalt > Search forZoho Recruit
>Settings
>Callback Url
> Copy it. - Paste the Callback URL under
Authorized Redirect URIs
and click on theCreate
button.
- Navigate to the
Client Secret
tab in the app and copy the Client ID and Client Secret.
Configuring credentials in Cobalt
App settings page lets you configure the authentication settings for an OAuth2
based application. For your customers to provide you authorization to access their data,
they would first need to install your application. This page lets you set up your application credentials.
Provide the acquired Client ID and Client Secret under Settings of the app and save it.
Configuring Scopes
Cobalt lets you configure what permissions to ask from your users while they install your application. The scopes can be added or removed from the App settings page, under Permissions & Scopes
section.
For some applications Cobalt sets mandatory scopes which cannot be removed. Additional scopes can be selected from the drop down. Cobalt also has the provision to add any custom scopes supported by the respective platform.
Once the scopes has been added to the application in Cobalt, the app will now request for access of the mentioned scopes.
If you are facing scopes missing or invalid scope error. Make sure you are not passing any custom scope not supported by the platform.
Zoho Recruit Single Webhook URL
If you wish to create an orchestration where a workflow is being triggered when some operation occurs in Zoho Recruit, you’d need to create a Zoho Recruit’s Webhook and add it as a Rule.
Cobalt provides a single webhook URL to manage such event triggers. The steps given below needs to be followed by all of your customers to setup webhooks in their account.
Let’s setup the Candidate Status changed webhook in Zoho Recruit. For this you need to do two steps:
1. Create Webhook Action
- Select Zoho Recruit from the application list in Cobalt > select
Settings
and copy theSingle Webhook URL
. - In Zoho Recruit, click on
Setup
(Gear icon) in the top bar and selectActions
present under Automation.
Your customers’ accounts should be on Zoho Recruit Standard or a higher plan to use webhooks.
- Switch to the
Webhooks
tab and click onConfigure Webhook
. - Provide a Name > Paste the
Single Webhook URL
that you copied under URL to Notify and select the Module asCandidates
. - Under
Append Entity Parameters
, go to Parameters in the User Defined Format, give theParameter Name
as data and copy the JSON provided below inValue Description
field.
- Under
Append Custom Parameters
, you need to add two parameters:
- First parameter name is
event
whose value will becandidate_state_changed
.The value of event will change based on the trigger that you are trying to setup. - Second parameter name is
identifier
whose value will be the email id of Zoho Recruit account that is being used.
- Click on
Save
to add the webhook.
2. Create Workflow Rule in Zoho Recruit
Once the user has created a webhook, they now need to add it as a Rule in Recruit so that it fires Cobalt event.
- Navigate to
Workflow Rules
under Automation and click on+ Create Rule
button. - Select Module as
Candidates
, add a Rule Name and click onNext
. - In the Rule, select
On a record action
> ChooseCandidate Stage
radio button for the Candidate Status Changed trigger and click onNext
.
Based on the trigger that you are using, you would select different action. For example in Candidate Created, you would choose the Create
radio button.
- Select
All Candidates
as the Condition 1 and click onNext
. - Select
Instant Actions
and click onWebhooks
. Select the Webhook that you created and click onAssociate
.
- Click on
Save
and your webhook is now completely setup for use.
Actions and triggers
Once the above setup is completed, you can create orchestrations of your use-cases using Zoho Recruit actions and triggers. Following are the set of Zoho Recruit actions and triggers supported by Cobalt.
- Candidate stage changed - Triggers when a candidate stage is changed in Zoho Recruit.
- Candidate created - Triggers when a candidate is created in Zoho Recruit.
- Application created - Triggers when an application is created in Zoho Recruit.
- Job opening status changed - Triggers when a job opening status is changed in Zoho Recruit.