Refer to the below schema for Apply Connect enabled job postings. These job postings will allow onsite application collection on LinkedIn job board.
Important
Ensure that partnerQuestionIdentifier are unique and not duplicated in job payloads. Duplicate questions will result in jobs unsuccessfully posting as onsite apply.
Requirements
For all synced jobs ensure application questions match all questions available on customer career sites.
OnsiteApplyConfiguration Fields
Field
Description
Type
Required
jobApplicationWebhookUrl
Required for Apply Connect. The URL where you will receive job applications from LinkedIn in near-realtime for this job posting. Note: Any URL that is passed into this field must be capable of passing the Webhook Endpoint Validation Flow.
Url
Yes
questions
Object containing all necessary info to render questions to be asked for a given JobPosting. If no questions are specified, then only basic default contact information questions will be asked during the application process (name, email, and phone number).
SimpleTalentQuestions
No
SimpleTalentQuestion Fields
Field
Description
Type
Required
contactInformationQuestions
Contact Information question section, if this field is null, then only mandatory contact information questions (First Name, Last Name, and Email) will be collected.
A collection of custom questions which can be added if questions don’t fit into any other question sections. Questions asked in additional Questions will be rendered in the “Additional Questions” section of the Job Application UI. If this field is null, then no Additional Questions will be asked.
Require submission of work experience, the work experience min limit can be set to 1, then at least 1 has to be provided in order to submit the subsection. If no minRequired is specified, this field will default to 0.
Integer
No
repeatLimit
The maximum number of times this question set can be asked, e.g. if the value is 1 then the question set will only appear once. For this question set, the acceptable range of values is [1, 10]. If no repeatLimit is specified, this field will default to 10.
integer
No
titleQuestionRequirement
Captures whether the "Title" question should be asked. If not specified, this field will default to REQUIRED.
Require submission of education experience, the education experience min limit can be set to 1, then at least 1 has to be provided in order to submit the subsection. If no minRequired is specified, this field will default to 0.
Integer
No
repeatLimit
The maximum number of times this question set can be asked, e.g. if the value is 1 then the question set will only appear once. For this question set, the acceptable range of values is [1, 3]. If no repeatLimit is specified, this field will default to 3.
integer
No
schoolQuestionRequirement
Captures whether the "School" question should be asked. If not specified, this field will default to REQUIRED.
The list of 1 or more custom questions that are a part of this custom question set. The ordering of these questions in this list will be maintained when rendering on UI.
The maximum number of times this question set can be asked, e.g. if the value is 1 then the question set will only appear once. For custom question sets, the valid range is [1, 10]. If no value is specified then repeatLimit will default to 1.
This question is required. An answer must be provided by the applicant in order to complete the job application.
OPTIONAL
This question is optional. An answer does not need to be provided by the applicant in order to complete the job application.
SKIP
This question is not rendered on the job application. No response will be provided for this question.
SimpleTalentQuestionDefinition Fields
Field
Description
Type
Required
partnerQuestionIdentifier
A unique identifier for this custom question. This is intended to be used by your systems to associate the answer(s) to this question when a job application is delivered by LinkedIn.
String
Yes
questionDetails
The details needed for a member to answer a question in any form. These question details will instruct the front-end as to how to render inputs and validation for this question.
Whether the question is required to complete the job application.
boolean
Yes
questionText
The label text to describe this question. This field supports the following formats: Unordered list <ui>, List item <li>, Bold <b>, Italic <i>, Links <a> and Paragraph <p>
String
Yes
helpMessage
Brief additional information available to the person being asked the question.
String
No
expandedHelpMessage
Full additional information available to the person being asked the question.
String
No
prerequisiteQuestionResponse
If this field is present, this question is displayed only when the prerequisite question is answered with the prerequisite response. Note that one CustomQuestionSet can only have one prerequisite question. Each answer value of the prerequisite question can be associated to one dependency question by specifying this field in the dependency question.
If this field is present, all other fields must be null. The representation of a question where a multiple-choice selection must be provided as the answer.
The text that will be used to describe the start date input. Defaults to "From".
String
No
endLabel
The text that will be used to describe the end date input. Defaults to "To".
String
No
hideEndDateLabel
The text that will be used to describe the input that will control whether or not the end date question is shown. For example, for employment dates this might be displayed as a checkbox with a label of "I currently work here". Checking the checkbox would unset and hide the end date question regardless of the content of the label.
String
Yes
PrerequisiteQuestionResponse Fields
Field
Description
Type
Required
prerequisiteQuestion
The prerequisite question that triggers the display of this question. The prerequisite question must be a multiple choice question with RADIO_BUTTONS as form component.
Maximum allowed size of the attachment in bytes. For resume 2 MB max size limit and cover letter 512 KB max size limit. Defaults to 100 MB.
long
No
acceptableFileExtensions
File extensions that you accept (e.g. doc, docx, pdf). These should always be listed in lowercase. Leaving out this optional field indicates that the ATS has no restrictions. An empty array indicates that the ATS only accepts files with no extension.
The symbolic name for the default answer value from the array of choices.
String
No
favorableMultipleChoiceAnswer
Fields that contains the favorable multiple choice answer value for this question. This should only be present for which the question has a preferred/required qualification.
Indicates whether the applicant is allowed to select more than one option when FormComponent is CHECKBOXES. Default to false
boolean
No
MultipleChoiceAnswerOption Fields
Field
Description
Type
Required
symbolicName
Machine-parsable name to refer to this particular answer.
String
Yes
displayValue
The display value for this multiple choice answer.
String
Yes
MultipleChoiceAnswerValue Fields
Field
Description
Type
Required
symbolicNames
An array of symbolic names for the answer value from the array of choices. Please specify only one symbolic name when this MultipleChoiceAnswerValue is used to represent a prerequisite answer value.
String[]
Yes
FavorableMultipleChoiceAnswer Fields
Field
Description
Type
Required
favorableSymbolicNames
The symbolicNames from MultipleChoiceQuestionDetails that should be considered favorable. An example could be [“BACHELOR”, “MASTERS”] to indicate that the job poster wants the candidate to have either one of the educational levels.
String[]
Yes
NumericQuestionDetails Fields
Field
Description
Type
Required
decimalQuestionDetails
If this field is present, the field integerQuestionDetails must be null. If this field is null, integerQuestionDetails must be present.
Fields that contains the favorable numeric answer value for this question. This should only be present for numeric questions for which the question is a preferred/required qualification.
String
No
DecimalQuestionDetails Fields
Field
Description
Type
Required
suggestedValue
The suggested answer that is prefilled for the applicant being asked the question.
float
No
minValue
The minimum value that is allowed for a decimal answer. Defaults to “0.0”.
float
No
maxValue
The maximum value allowed for a decimal answer.
float
No
IntegerQuestionDetails Fields
Field
Description
Type
Required
suggestedValue
The suggested answer that is prefilled for the applicant being asked the question.
integer
No
minValue
The minimum value that is allowed for a decimal answer. Defaults to “0”.
integer
No
maxValue
The maximum value allowed for an integer answer.
integer
No
FavorableNumericAnswer Fields
Field
Description
Type
Required
favorableFloor
The minimum inclusive value that will be considered favorable. For example, this field would be set to 5.0 if you want to capture ‘Minimum 5 years of experience’. Null means negative infinity.
float
No
favorableCeiling
The maximum inclusive value that will be considered favorable. Null means infinity.
float
No
TextQuestionDetails Fields
Field
Description
Type
Required
suggestedValue
The suggested answer that is prefilled for the applicant being asked the question.
String
No
minLength
The minimum text length for the answer. Defaults to 0.
integer
No
maxLength
The maximum text length for the answer.
integer
No
preferredFormComponent
Indicates whether a one-line or multi-line text input should be used. Should be TEXT or MULTILINE_TEXT.