Recruitee Partner API Integration

​

Overview

​

Partner Requirements

​

Provider Side Setup

​

StackOne Configuration

1

Navigate to enable the Recruitee at StackOne

Go to the ATS category on the Integrations page and enable Recruitee.

2

Enable and Configure Recruitee in StackOne

Complete the necessary fields in the Recruitee - Configuration modal:

• Authentication Type: Select Public + Partner API to integrate with Recruitee (for Assessment/Background Check integration).
  Difference between Public API & Partner API

  • Public API: Access to the StackOne Unified APIs, excluding the Assessments and Background Checks Unified API and its features.
  • Partner API: Access to the Assessments and Background Checks Unified API and its features, but not other StackOne Unified APIs. This allows you to integrate your provider's partner app with StackOne.
  • Public + Partner API: Access to all StackOne Unified APIs, including the Assessments and Background Checks Unified API and its features.
• Environment Type: If you have a Release Candidate (RC) environment account on Recruitee, select Staging as the environment type; otherwise, select Production.
• Partner Category: Select the appropriate category based on your integration’s classification as a partner for Recruitee, e.g. Assessments or Background Checks.
• Package’s List Endpoint URL: Implement and provide an endpoint to StackOne that StackOne will use to retrieve the list of packages when the recruiter wants to send a test to a candidate. Implement the following POST endpoint:
  Copy

  Ask AI

  curl --location 'https://your-domain.com/<route-to-the-post-endpoint>' \
  --header 'Content-Type: application/json' \
  --header 'x-stackone-signature: string' \
  --header 'Authorization: Basic <base64encoded-api-key>' \
  --data '{
      "account_id": "456551489512493414",
      "provider": "recruitee"
  }'
  

  The expected response of the POST endpoint (list of packages). Refer to:
  • List Assessments Packages
  • List Background Check Packages
  Enter the endpoint into the designated field:
  Copy

  Ask AI

  https://your-domain.com/<route-to-the-post-endpoint>
  

• Package ID: If you do not have the Package’s List Endpoint URL, you can specify a particular package ID that will be visible to the recruiter when they wish to send the test to the candidate.
  How is the Package's List Endpoint URL different from a Static Package ID?

  The Package’s List Endpoint URL allows StackOne to fetch a list of available packages from your system, while the Static Package ID is fixed and available for users to select on the provider’s side.

  • When you have a Package’s List Endpoint URL, a list of packages will be available to select in Recruitee.

  

  • When you have a Static Package ID, a static package ID will be available to select in Recruitee.
  At least one field is necessary for making packages available in the provider’s UI. Preference will be given to the Package’s List Endpoint URL if both fields are configured.
• Partner Codename: A unique identifier for the partner, used to identify your integration on the Recruitee marketplace. It must consist of lowercase letters and dashes (-) and be globally unique.
• Name: The name of your integration that will be displayed on the Recruitee dashboard.
• Description: A brief overview of your integration that will be displayed on the Recruitee dashboard.
• Logo: The logo of your integration that will be displayed on Recruitee.

Click the Confirm or Save Changes button to enable Recruitee, which allows end-users to link their accounts via the StackOne Connector Hub.

3

Add a Webhook

Navigate to the Webhooks page, click on Add webhook and fill out the form:

• Name: Enter a recognisable name for your webhook.
• URL: Enter the URL where the webhook will send notifications for the enabled events.
  

Enable webhook events from the Events tab for Assessment and Background Check, such as Assessments Order and Background Check Order.

Click the Confirm and Save buttons to add the webhook.

​

ATS User Enablement

1

To obtain the External Trigger Token

Navigate to the Accounts page or the StackOne Connector Hub to link your Recruitee account with StackOne.

Users will receive the External Trigger Token required to enable the integration from the Recruitee Marketplace.

2

Go to Recruitee Marketplace

Navigate to Marketplace page, select either Assessments or Background Checks from Categories.

3

To enable the integration

Search for your integration partner’s name in the search bar.

Click on the integration app, then click Integrate button to proceed further,

A pop-up will appear displaying the details of the integration along with an Accept and Integrate button. Click on the button to proceed to the next step.

For Partners: To test your integration using the Recruitee Sandbox, you need to input an External Trigger Token into the integration from the marketplace to integrate.For Users: Each user needs to input an External Trigger Token to connect with your integration.

The user will enter the External Trigger Token retrieved from the StackOne Connector Hub as mentioned in the above steps, then click on Integrate to enable the integration app.

The user can modify the permissions for different roles associated with this integration. Once done, click the Save button to apply the changes.

The user can refer to the Recruitee Assessment or Background Check Guide for instructions on how to enable the Recruitee integration app from the Marketplace.

​

ATS User Experience

1

Select Candidate from the Candidates

Navigate to the Candidates page and select the candidate.

2

Send test notification

Click on the menu icon, then select integration app to proceed.

A pop-up will appear, allowing users to select the assessments test.

Select the assessments test, wait a few seconds for the Send button to become enabled, and then click Send to dispatch the notification.

Once the assessments test notification is successfully sent, users can view the test status on the candidate’s profile as shown below:

​

ATS User Experience Customisation

1

To Update the result via unified api

Utilise the following endpoints to update the results:

• Assessment Update Result
• Background Check Update Result

Utilise the following endpoint to get metadata to update the result of the assessment or background check:

• Connector Meta Information with the provider key recruitee for model assessments/results.update or background_checks/results.update

Condition	User sees in Recruitee
Result URL	Visible as an Open link
Score’s Value	Visible as a percentage alongside the package’s name.
Result Status	Visible within the score’s tooltip, if the user hovers on the score.

2

How will the results of the assessment/background check be displayed to the user in Recruitee?

Navigate to the candidate profile, where you will see the updated results along with the score from the previously sent test. This information will be available once the candidate has completed the assessment and background check.

​

Testing Checklist

• Once the integration is approved/published by Recruitee, it is visible in the Recruitee Marketplace under Assessments or Background Checks categories.

• Selected Public + Partner API as the Authentication Type.
• Package’s List Endpoint URL is correct.
• Package’s List Endpoint response is as expected according to the following endpoint’s response:
  • List Assessments Packages
  • List Background Check Packages
• Valid partner codename and other details, as mentioned here.

• Valid External Trigger Token to enable the partner integration.
• Once enabled, the integration will be available for selection under the candidate’s application.

• Added a webhook for Recruitee and enabled it with the events such as: Assessment Order or Background Check Order.
• Valid webhook URL to receive assessment/background check notifications.

• Once enabled, the integration will be available for selection under the candidate’s application.
• If you have configured the Package’s List Endpoint URL, a list of packages is visible in the dropdown field when the user initiates sending the test to the candidate.
• If you have configured a Static Package ID, a single package is visible in the dropdown field when the user initiates sending the test to the candidate.
• Select a package, click Send Test, and send the webhook. A Pending icon as a status along with the assessment package name will appear if the notification has been sent.

• Success response from the update result endpoint.
• Updated result details to Recruitee’s UI.

​

Troubleshooting