Workable

List candidates and job postings in Workable.

On this page

Connect
Call it from a workflow
Actions (7)
getCandidate
getJob
getMembers
getStages
moveCandidate
rateCandidate
custom_api_call
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("workable", "getCandidate", {
    "id": "<candidate's id>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Workable answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "workable-getcandidate",
  name: "Workable: Get Candidate",
  description: "Calls Workable when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("workable", {
      "action": "getCandidate",
      "id": "<candidate's id>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/workable/getCandidate" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"id":"<candidate's id>"}}'

Actions

getCandidatein catalog

Get Candidate. Gets candidate's information.

Input	Type	Description
`id`required	text	Candidate's Id

getJobin catalog

Get Job. Gets specific job deatils.

Input	Type	Description
`shortcode`required	text	Shortcode of specific job

getMembersin catalog

Get Members. Gets members of hiring team.

Input	Type	Description
`limit`optional	number	Default is 50
`role`optional	text	Filter for member of specified role
`shortcode`optional	text	Shortcode of specific job
`email`optional	text	Filter for specific member by email
`name`optional	text	Filter for members of specified name (Exact Match)

getStagesin catalog

Get Stages. Gets stages in your recruitment pipeline stages.

Input	Type	Description
`shortcode`required	text	Shortcode of specific job

moveCandidatein catalog

Move Candidate. Moves candidate to the specified stage.

Input	Type	Description
`id`required	text	Id of candidate
`member_id`required	text	This person's Id is used to move the candidate to the next stage
`target_stage`required	text	Slug of stage target should be moved to

rateCandidatein catalog

Rate candidate. Rates the candidate on workable.

Input	Type	Description
`id`required	text	Id of candidate
`member_id`required	text	Id of member that is adding the rating
`comment`required	long text	Comment about the scoring of the candidate
`scale`required	one of "thumbs" \| "stars" \| "numbers"	Select scale to rate candidate on
`grade`required	number	Thumbs scale: 0-2, Stars scale: 0-4, Numbers scale: 0-9

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

Details

Id: workable
Category: HR
Tags: ats, recruiting, jobs, hiring
Package: @activepieces/piece-workable@0.1.4
Tier: Community