https://github.com/tumblbug/gatsby-source-workable

Gatsby source plugin for loading job openings from Workable
https://github.com/tumblbug/gatsby-source-workable

gatsby gatsby-source workable

Last synced: about 2 months ago
JSON representation

Gatsby source plugin for loading job openings from Workable

• Host: GitHub
• URL: https://github.com/tumblbug/gatsby-source-workable
• Owner: tumblbug
• License: mit
• Created: 2017-08-29T02:30:52.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-06-27T15:03:15.000Z (over 2 years ago)
• Last Synced: 2024-08-09T03:07:41.344Z (5 months ago)
• Topics: gatsby, gatsby-source, workable
• Language: JavaScript
• Size: 9.77 KB
• Stars: 2
• Watchers: 12
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gatsby-source-workable

> Loads job openings from Workable into Gatsby.js

## Installation

```bash

npm install gatsby-source-workable

```

## Usage

To use this source you need to supply a Workable API key and your Workable subdomain. You can create a Workable API key by logging into Workable and going to `Integrations > Access Token`. You can see your subdomain by logging into your Workable backend and checking the URL, e.g. `mycompany.workable.com`.

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

```javascript

{

    ...

    plugins: [

    ...

    {

      resolve: 'gatsby-source-workable',

      options: {

        subdomain: 'mycompany',

        apiKey: 'abc-123',

        fetchJobDetails: true // optional

      },

    },

  ]

}

```

By default, `gatsby-source-workable` will only retrieve job openings that are published. To change this behavior, you can also supply an optional `queryParams` parameter inside of `options`. Possible query parameters are detailed in [Workable's API Documentation](https://workable.readme.io/docs/jobs).

If you need more detailed information for each job opening you can also enable `fetchJobDetails` in `options`. This will make one additional API call per opening, providing all the information detailed [here](https://workable.readme.io/docs/jobsshortcode).

## Querying

You can query the nodes created by the plugin as follows:

```graphql

{

    allWorkableJob {

        edges {

            node {

                ...

            }

        }

    }

}

```

Detailed field descriptions are also available on [Workable's API Documentation](https://workable.readme.io/docs/jobs).