Overview
WeCP can integrate with dozens of off-the-shelf and home-grown tools – we will collectively call these tools ATS. And this is a developer guide to creating an integration with WeCP. You will find all the information you need in this article to create an integration with WeCP on your own.
Off-the-shelf tools | Workday, Workable, Zoho Recruit, iCIMS, Oracle Taleo, Jobvite, Oracle Recruiting Cloud, Greenhouse, Lever, Kenexa, Instahyre, RecruiterBox, Jazz, SmartRecruiters, Avature, Breezy, Eightfold, BrassRing, Goodtime, etc. |
Home-grown tools | Any such tool that is built inhouse at your company |
How will this integration help?
Other tools that you use in talent acquisition, such as the above COTS (Commercial Off-The-Shelf) systems or your internal tools – we collectively call them in this article ATS involve many routine tasks, such as:
inviting candidates to take a WeCP Test directly from ATS
conducting a WeCP Interview with candidates and interviewers
accessing performance (test + interviews) reports of candidates in the ATS
building a Talent pool inside WeCP
onboard candidate to HRMS systems after they're hired
Hence, this integration would eliminate the back and forth involved between different tools to exchange data. WeCP provides API calls that will help build this integration and further implement the aforementioned tasks from within the ATS UI.
The Integration Process
The first step is to create a WeCP account by signing up here: https://assess.wecreateproblems.com/auth/onboarding . This account is required to access API keys and API endpoints.
The second step is to go study the API documentation and get ready to write code. In case of any questions related to API documentation, speak to the partner success manager from WeCP or simply drop an intercom chat message on the platform.
Once you have familiarized yourself with the API and decided the flows you want to support in your tool, please reach out to your WeCP partner success manager or drop us an intercom chat message on the platform asking for a partner key and secret token. You will also be issued a ‘Company-wide API Key’ to use with your integration.
Next is to start writing integration code as per the correct authentication mechanism. You'll need to make the below three changes:
Add a custom header “X-WECP-Partner-Authorization: xxxx” where xxxx should be replaced with a base64-encoded version of PartnerKey:PartnerSecret.
Add a custom header “WECP-User-Email: user@example.com” where user@example.com should be replaced with the email of the user initiating the request through your application. This should match an existing user in the customer's WeCP account.
Use the Company-wide API Key in place of the Personal Access Token you would have used while you explored the API in your account.
Note: With every call you make, you may also choose to include some additional metadata in your payload if there is metadata you need WeCP to save.
Some commonly seen fields include:
user_email: should identify the user initiating the request. This should match an existing user in the customer's HRW account.
candidateId:may be the unique identifier for this candidate in your system. Some API calls are not candidate-specific, and in such cases, you can ignore this field.
applicationId: can be used if a candidate is able to apply to more than one Req.
This can be a different field and identify the specific application. Some API calls are not candidate-specific, and in such cases, you can ignore this field.{
...
"metadata": {
"candidateId": "85612734",
"applicationId": "98131512",
"user_email": "user@example.com"
}
}Using the Partner authorization token and per-company keys are important as we have a different set of policies and rate limits. It also helps us troubleshoot customer issues originating from you more easily, leading to a better user experience.
After building the integration with WeCP, you can inform the partner success manager to begin the integration review for all the cases.
Once successfully reviewed, congratulations, your integration will be made live in WeCP, and your customers would be able to use WeCP from within your ATS UI.