Application Requirements/Schema

The jobSchema defines the structure that every job application must follow. It includes details such as the job ID, URL, inputs for the application, filename, cover letter, and profile ID. On this page, we'll dive into the structure and provide examples to help you format your applications accordingly.

Application Schema

The job application model contains all the necessary information for submitting an application. It must adhere to the following structure:

Properties

  • Name
    jobId
    Type
    string
    Description

    Unique identifier for the job. (optional, only requred if applying to a Wrangle-supplied job)

  • Name
    url
    Type
    string
    Description

    URL for the job, stripped of URL parameters.

  • Name
    inputs
    Type
    array
    Description

    An array of dictionaries containing the label, tag, type, selector, and value for each input field in the application.

  • Name
    filename
    Type
    string
    Description

    Resume filename.

  • Name
    coverLetter
    Type
    string
    Description

    Text of the cover letter. This field is optional.

  • Name
    profileId
    Type
    string
    Description

    Identifier for the profile used in the application.

Example Code Snippet

Below is an example of how to structure a job application using the jobSchema:

const jobApplications = [
  {
    jobId: '12345', // only required to apply to jobs in Wrangle's database
    url: 'https://example.com/job/12345',
    inputs: [
      {
        label: 'Full Name',
        tag: 'input',
        type: 'text',
        selector: '#name',
        value: 'John Doe',
      },
      {
        label: 'Email Address',
        tag: 'input',
        type: 'email',
        selector: '#email',
        value: 'john.doe@example.com',
      },
      // additional inputs as needed
    ],
    filename: 'resume.pdf',
    coverLetter: 'Dear Hiring Manager, ...',
    profileId: 'profile-67890',
  }
];

Was this page helpful?