Added optional name and description parameters to the POST /webhooks-api/v201907/subscriptions endpoint request and response.
Both fields are validated:
name should have maximum length of 100 characters, and contain only alphanumeric characters and spaces,
description should have maximum length of 500 characters, and cannot contain ;\<>{} characters.
If present, name and description parameters will be added to responses for endpoints:
GET /webhooks-api/v201907/subscriptions
GET /webhooks-api/v201907/subscriptions/{subscriptionId}
Impact
This enhancement is backward-compatible and does not require any changes to existing client implementations.
Extending Self Scheduling API by adding endpoints to:
retrieve available slots for interview
create interview at a specific slot
update interview at a specific slot
To use this API, you will need the following access scopes: self_schedules_read or self_schedules_manage.
Impact
The Self Schedule API allows to create, delete and search for interview self schedules, providing similar functionality as the UI.
Self scheduling allows candidate to pick up the time slot for the interview, and interview would be created as a result.
Assessment API(v1) endpoints, that were officially sunset on June 10th 2024, are removed. This API was replaced by the Assessment API(2021).
Removed endpoints:
GET https://api.smartrecruiters.com/v1/assessments
POST https://api.smartrecruiters.com/v1/assessments
POST https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/reject
POST https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/complete
POST https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/accept
GET https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}
GET https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/comments
POST https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/comments
GET https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/comments/{commentId}
Related Offers API(v1) endpoints are also removed:
POST https://api.smartrecruiters.com/v1/offers
GET https://api.smartrecruiters.com/v1/offers/{offerId}
POST https://api.smartrecruiters.com/v1/offers/{offerId}
POST https://api.smartrecruiters.com/v1/offers/{offerId}/withdraw
POST https://api.smartrecruiters.com/v1/offers/{offerId}/submit
with the exception of GET https://api.smartrecruiters.com/v1/offers, which is not removed.
Impact
This change is not backward-compatible.
All customers using the Assessment API(v1) and Offers API (v1) no longer have access to these APIs.
All integrations still using these APIs are affected.
Introducing new public API - Interview Templates API.
This API allows to create, update, delete and search for interview and job interview templates.
It is also responsible for managing the interviewer scheduling preferences.
To use this API, you need to be granted the following access scopes: interview_templates_read, interview_templates_manage, schedule_preferences_read.
Impact
The Interview Templates API empowers users to interact with the interview / job interview templates and interview scheduling preferences.
There are neither breaking changes in the existing API nor any migration steps required.
Introducing the General Partner Integration flow.
The General Partner Integration flow is a new approach to integrating partners and customers.
It follows the OAuth 2.0 protocol and uses the Client Credentials flow to securely exchange data with integrated systems.
Impact
This change is backward-compatible and does not require any modifications to existing clients.
Introducing new endpoints for managing Access Groups in Configuration API. They allow to read, update, create, delete, and list Access Groups details and configuration.
These are the new access groups endpoints:
getting list of access groups: GET /configuration/access-groups
creating new access group: POST /configuration/access-groups
getting access group details: GET /configuration/access-groups/{accessGroupId}
updating access group details: PUT /configuration/access-groups/{accessGroupId}
New set of endpoints gives API users Access Groups management capabilities available so far only on the UI.
This enhancement is backward-compatible and does not require any changes to existing client implementations.
The response of GET /postings/{uuid}/configuration now includes two new properties: consentSettings and companyImprintUrl. Consent settings contains list of consent scopes with details. Each scope is described by its scope key, flag indicating whether scope acceptance is required and a consent text statement (as configured in company policy settings).
If there is no customer privacy policy configured, the scopes of consentSettings will be an empty list.
Impact
This is a non-breaking change, as it only enhances the response of a single endpoint.
Consumers of POST /postings/{uuid}/candidates can now analyze the required data there without additional checks of the compliance configuration.
