API Changelog

August 23rd 2021

Webhook

Webhook custom authentication header now supports OAuth 2.0 Client Credential.

Webhook users who are looking for additional authentication when SmartRecruiters call the callbackUrl can specify clientId, clientSecret and TokenServiceUrl when creating the webhook subscription. If configured, SmartRecruiters will pass the access token exchanged from the TokenServiceUrl in the custom header of the callback.

August 16th 2021

Webhook

We have added 4 additional webhook events that webhook users will be able to subscribe to:

  • job.approver.skipped – Event callback will trigger when an approver of a job approval request is skipped
  • offer.approver.skipped – Event callback will trigger when an approver of an offer approval request is skipped.
  • job.approver.delegated – Event callback will trigger when a delegated approver is assigned by the original approver to substitute the original approver to approve the job for a selected period of time.
  • offer.approver.delegated – Event callback will trigger when a delegated approver is assigned by the original approver to substitute the original approver to approve the offer for a selected period of time.

August 9th 2021

Webhook

We have added 4 additional webhook events that webhook users will be able to subscribe to:

  • job.approval.step.approved – Event callback will trigger when the approver of the step of the approval process approved the job.
  • offer.approval.step.approved – Event callback will trigger when the approver of the step of the approval process approved the offer.
  • job.approval.step.rejected – Event callback will trigger when the approver of the step of the approval process rejected the job.
  • offer.approval.step.rejected – Event callback will trigger when the approver of the step of the approval process rejected the offer.
Posting

The property jobAdId is added into the response payload for the RetrievePosting endpoint.

July 15th 2021

Pagination

Cursor-based pagination is now available on both ListCandidates and ListJobs. We introduce the change because cursor-based pagination can help reduce latency in performance when users interact with more stability and reliability to SmartAPIs and SmartRecruiters systems

With an introduction of cursor-based pagination the offset-based pagination for these two endpoints will begin to sunset and will not be supported after the May 2022.

To ensure your application will continue to work after May 2022 and to take advantage on the improved performance cursor-based pagination has to offered, we recommend adjusting and updating your applications and integrations to the cursor-based pagination approach as soon as possible.

April 2018

Analytics API Deprecated

Endpoints in the Analytics API has been deprecated as of Apr. 26, 2018. These endpoints will function for existing integrations through Feb. 28, 2019, with the exception of the Interviews data service which will be made available to customers until April 30, 2019.

Customers should switch to the new Reporting API for any analytics integrations or to access reports as soon as possible.

Configuration API GET:/users endpoints moved to User API

We’ve extracted the Users API endpoints originally part of the Customer API into its own API now called User API. There should be no changes to any pre-existing functionality provided by those endpoints. We have added Access Group functionality to the User API.

We also released an updated version of the API that points to a slightly different endpoint URL. This may affect existing integrations. Please check your integration to make sure it’s working as expected.

January 2018

Candidate API Updates

With the introduction of Parallel Applications functionality, we are deprecating Candidate API endpoints that no longer represent the current data model. If you are using any of the deprecated endpoints today, you must migrate to the corresponding alternative endpoints by November 29, 2018. 

We will be extending the life of these endpoints until January 31, 2019 to provide customers with more time to adjust their integrations. We recommend migrating integrations to the alternate version of the endpoint as soon as possible. 

Read more about these updates: https://dev.smartrecruiters.com/customer-api/january-2018-updates/ 

Deprecated endpoints

Alternative endpoints

PUT /candidates/{id}/onboardingStatus

PUT /candidates/{id}/jobs/{jobId}/onboardingStatus

GET /candidates/{id}/onboardingStatus

GET /candidates/{id}/jobs/{jobId}/onboardingStatus

GET /candidates/{id}/properties

GET /candidates/{id}/jobs/{jobId}/properties

PUT /candidates/{id}/properties/{propertyId}   

PUT /candidates/{id}/jobs/{jobId}/properties/{propertyId}

PUT /candidates/{id}/status

PUT /candidates/{id}/jobs/{jobId}/status

GET /candidates/{id}/status/history

GET /candidates/{id}/jobs/{jobId}/status/history