Gatsby Book Launch

“The missing guide to the modern web” launches on Thursday, Sep 29th: Modular: The Web’s New Architecture

ContactSign Up for Free
Community Plugin
View plugin on GitHub

gatsby-source-greenhouse-job-board

Source plugin for pulling jobs into Gatsby from the Greenhouse Job Board API.

Installation

npm install gatsby-source-greenhouse-job-board-lite

or

yarn add gatsby-source-greenhouse-job-board-lite

Usage

To use this source you need to provide a Greenhouse Job Board token. You can find this token by logging into Greenhouse and going to Configure > Dev Center > Configure Job Board. It will be listed next to the heading ‘Your Board Token’.

Next, edit gatsby-config.js to use the plugin:

{
  ...
  plugins: [
    ...
    {
      resolve: 'gatsby-source-greenhouse-job-board-lite',
      options: {
        boardToken: '{board token}'
      },
  ]
}

How to query

You can query nodes created from the Greenhouse Job Board API using GraphQL like the following:

Note: Learn to use the GraphQL tool and Ctrl+Spacebar at http://localhost:8000/___graphql to discover the types and properties of your GraphQL model.

{
  allGreenhouseJobs {
    edges {
      node {
      title
      absolute_url
        location {
          name
        }
        content
      }
    }
  }
}

All Greenhouse data is pulled using the Greenhouse Job Board API. Data is made available in the same structure as provided by the API.

Note: The following example is not a complete reference to the available fields. Utilize Gatsby’s built-in GraphQL tool to discover the types and properties available.

Query jobs

Jobs are linked to their departments and offices, which following the format of the API, returns an array.

{
allGreenhouseJob {
    edges {
      node {
        id
        internal_job_id
        title
        absolute_url
        content
        updated_at(formatString: "ddd, MMMM Do, YYYY")
        questions {
          label
          required
          fields {
            name
            type
            values {
              label
              value
            }
          }
    	  }
        location {
          name
        }
        departments {
          name
        }
        offices {
          name
          id
        }
      }
    }
  }
}

Job Board vs. Harvest API

Greenhouse provides two APIs for sourcing information on open jobs, Harvest and Job Board. For most use-cases that involve presenting and displaying job posts on a website, the Job Board API is sufficient and recommended because:

  • No authentication is required, therefore no need to manage secrets. etc.
  • Harvest API provides a significant amount of data which some individuals and/or organizations may consider to be sensitive

More information on the Job Board API can be found on the Greenhouse Developer Website.

© 2022 Gatsby, Inc.