Context for accessing Workable API functions.

Requires config.exs to have a setup incantation like so:

config :library, 
  Library.Workable: [
    api_token: "yer token"
  ]

Sync with Workable

Incoming Apps

Synching with Workable is easy because they have webhooks! We've configured a webhook to the following HIVE endpoint: https://hive.explo.org/webhook/workable/candidate/hired

Whenever a candidate is hired on Workable, a HIVE atom {workable, candidate, hired}, will be created, and the data posted will be in this format.

Manual API Queries

Workable can also be queried directly from the Z repository via this module. This module is where we configured the webhook (subscriptions) endpoint, but you can also use it to list jobs and candidates, as well as getting more candidate detail on a per-candidate (ID) basis. This was how we created the initial list of candidates who had been hired prior to configuring the webhook.

# create the one subscription we need (this should only really happen once)
endpoint = "https://hive.explo.org/webhook/workable/participant/hired?token=TOKENHERE"
{:ok, response} = Z.External.Workable.post_subscription %{target: endpoint, event: "candidate_moved", args: %{account_id: "explo", stage: "hired"}}

A Word on API Formats

The /candidate/:id format and the webhook:candidate_moved format are very similar but not the same. Basically, the main JSON key is different (candidate versus data) and the webhook doesn't contain the full candidate picture.

Accordingly, the method to convert a candidate to a HIVE atom candidate_to_hive_atom/1 is to swap the keys. Then, on receipt, we hit the candidate endpoint with candidate ID and use that data. See ZWeb.API.Staff.ApplicationsController for more details there.