Share via


Workable (Independent Publisher) (Preview)

The Workable connector can be used in the following ways:

Extract information about your: account hiring members pipeline stages jobs scheduled events job's and/or candidate's activity

Manage your candidates by: Fetching candidates Extracting detail candidate info

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name David Kjell
URL https://breatheit.no
Email david@breathe.no
Connector Metadata
Publisher David Kjell
Website https://workable.com
Privacy policy https://workable.readme.io/
Categories Commerce;Human Resources

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Workable API Key securestring Provide your API Key from Workable True
Workable Endpoint URL string Provide your Workable Endpoint URL ('https://subdomain.workable.com/') True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get a Job by shortcode

Get a Job by shortcode

Get Accounts

Get Accounts: Returns a collection of all the accounts you have access to.

Get Candidate Offer

Get Candidate Offer

Get Candidates

Get Candidates: Returns a collection of the job's candidates.

Get Candidates by ID

Get Candidates by ID: Returns specified candidate.

Get Custom Attributes

Get Custom Attributes

Get Events

Get Events: Returns a collection of your events.

Get Events by ID

Get Events by ID: Returns date for the identified event.

Get Job Activities by shortcode

Get Job Activities by shortcode: Returns the activity stream of the given job.

Get Jobs

Get Jobs

Get Members

Get Members

Get Stages

Get Stages

Get Subscriptions

Get Subscriptions: List all subscriptions.

Post a Subscription

Post a Subscription: Subscribe to an event.

Get a Job by shortcode

Get a Job by shortcode

Parameters

Name Key Required Type Description
Job Short Code
shortcode True string

Job Short Code

Returns

Name Path Type Description
Job ID
id string

Job ID

Job title
title string

Job title

Full title
full_title string

Full title

Shortcode
shortcode string

Shortcode

Code
code string

Code

State
state string

State

Department
department string

Department

url
url string

url

Application url
application_url string

Application url

Short link
shortlink string

Short link

Country
location.country string

Country

Country code
location.country_code string

Country code

Region
location.region string

Region

Region code
location.region_code string

Region code

City
location.city string

City

Zip code
location.zip_code string

Zip code

Telecommuting
location.telecommuting boolean

Telecommuting

Created On
Created On string

Created On

Full description
Full description string

Full description

Description
description string

Description

Requirements
requirements string

Requirements

Benefits
benefits string

Benefits

Employment type
employment_type string

Employment type

Industry
industry string

Industry

Function
function string

Function

Experience
experience string

Experience

Education
education string

Education

Keywords
keywords string

Keywords

Get Accounts

Get Accounts: Returns a collection of all the accounts you have access to.

Returns

Name Path Type Description
Accounts
accounts array of object

Accounts

Account ID
accounts.id string

Account ID

Account name
accounts.name string

Account name

Subdomain
accounts.subdomain string

Subdomain

Description
accounts.description string

Description

Summary
accounts.summary string

Summary

Website url
accounts.website_url string

Website url

Get Candidate Offer

Get Candidate Offer

Parameters

Name Key Required Type Description
Get Candidate Offer
id True string

Offer ID

Returns

Name Path Type Description
Offer ID
candidate.id string

Offer ID

Location
candidate.location string

Location

Name
candidate.name string

Name

Created On
Created On string

Created On

State
state string

State

Document variables
document_variables array of object

Document variables

Name
document_variables.document_variable.name string

Name

Slug
document_variables.document_variable.slug string

Slug

body
document_variables.value.body string

body

Documents
documents array of object

Documents

Name
documents.name string

Name

Preview url
documents.preview_url string

Preview url

Kind
documents.kind string

Kind

Get Candidates

Get Candidates: Returns a collection of the job's candidates.

Returns

Name Path Type Description
candidates
candidates array of object

candidates

Candidate ID
candidates.id string

Candidate ID

Name
candidates.name string

Name

Firstname
candidates.Firstname string

Firstname

Lastname
candidates.Lastname string

Lastname

Headline
candidates.Headline string

Headline

Subdomain
candidates.account.subdomain string

Subdomain

Name
candidates.account.name string

Name

Short code
candidates.job.shortcode string

Short code

Title
candidates.job.title string

Title

Stage
candidates.stage string

Stage

Disqualified
candidates.disqualified boolean

Disqualified

Disqualification Reason
candidates.disqualification_reason string

Disqualification Reason

Hired On
candidates.hired_at string

Hired On

Sourced
candidates.sourced boolean

Sourced

Profile url
candidates.profile_url string

Profile url

Address
candidates.Address string

Address

Phone
candidates.phone string

Phone

Email
candidates.email string

Email

Domain
candidates.domain string

Domain

Created On
candidates.Created On string

Created On

Updated On
candidates.updated_at string

Updated On

Next
paging.next string

Next

Get Candidates by ID

Get Candidates by ID: Returns specified candidate.

Parameters

Name Key Required Type Description
Get Candidates by ID
id True string

Candidates ID

Returns

Name Path Type Description
Candidate ID
candidate.id string

Candidate ID

Name
candidate.name string

Name

Firstname
candidate.Firstname string

Firstname

Lastname
candidate.Lastname string

Lastname

Headline
candidate.Headline string

Headline

Image url
candidate.image_url string

Image url

Subdomain
candidate.account.subdomain string

Subdomain

Account Name
candidate.account.name string

Account Name

Job Short Code
candidate.job.shortcode string

Job Short code

Job Title
candidate.job.title string

Job Title

Stage
candidate.stage string

Stage

Disqualified
candidate.disqualified boolean

Disqualified

Disqualified On
candidate.disqualified_at string

Disqualified On

Disqualification Reason
candidate.disqualification_reason string

Disqualification Reason

Hired On
candidate.hired_at string

Hired On

Sourced
candidate.sourced boolean

Sourced

Profile url
candidate.profile_url string

Profile url

Address
candidate.Address string

Address

Phone
candidate.phone string

Phone

Email
candidate.email string

Email

Outbound Mailbox
candidate.outbound_mailbox string

Outbound Mailbox

Domain
candidate.domain string

Domain

Uploader ID
candidate.uploader_id string

Uploader ID

Created On
candidate.Created On string

Created On

Updated On
candidate.updated_at string

Updated On

Cover Letter
candidate.cover_letter string

Cover Letter

Summary
candidate.summary string

Summary

Education Entries
candidate.education_entries array of object

Education Entries

Education ID
candidate.education_entries.id string

Education ID

Degree
candidate.education_entries.degree string

Degree

School
candidate.education_entries.school string

School

Field of study
candidate.education_entries.field_of_study string

Field of study

Start date
candidate.education_entries.start_date string

Start date

End date
candidate.education_entries.end_date string

End date

Experience entries
candidate.experience_entries array of object

Experience entries

Experience ID
candidate.experience_entries.id string

Experience ID

Experience Title
candidate.experience_entries.title string

Experience Title

Experience summary
candidate.experience_entries.summary string

Experience summary

Experience Start date
candidate.experience_entries.start_date string

Experience Start date

Experience End date
candidate.experience_entries.end_date string

Experience End date

Company
candidate.experience_entries.company string

Company

Industry
candidate.experience_entries.industry string

Industry

Current
candidate.experience_entries.current boolean

Current

Skills
candidate.skills array of

Skills

Answers
candidate.answers array of

Answers

Resume url
candidate.resume_url string

Resume url

Social profiles
candidate.social_profiles array of object

Social profiles

Social profile Type
candidate.social_profiles.type string

Social profile Type

Social profile Name
candidate.social_profiles.name string

Social profile Name

Social profile username
candidate.social_profiles.username string

Social profile username

Social profile url
candidate.social_profiles.url string

Social profile url

Tags
candidate.tags array of

Tags

Location
candidate.location.location_str string

Location

Country
candidate.location.country string

Country

Country code
candidate.location.country_code string

Country code

Region
candidate.location.region string

Region

Region code
candidate.location.region_code string

Region code

City
candidate.location.city string

City

Zip code
candidate.location.zip_code string

Zip code

Originating candidate ID
candidate.originating_candidate_id string

Originating candidate ID

Get Custom Attributes

Get Custom Attributes

Returns

Name Path Type Description
custom_attributes
custom_attributes array of

Custom attributes

Get Events

Get Events: Returns a collection of your events.

Returns

Name Path Type Description
Events
events array of object

Events

Event ID
events.id string

Event ID

Title
events.title string

Title

Description
events.description string

Description

Event Type
events.type string

Event Type

Starts On
events.starts_at string

Starts On

Ends On
events.ends_at string

Ends On

Job Short code
events.job.shortcode string

Job Short code

Title
events.job.title string

Title

Members
events.members array of object

Members

Member ID
events.members.id string

Member ID

Name
events.members.name string

Name

Status
events.members.status string

Status

Candidate ID
events.candidate.id string

Candidate ID

Name
events.candidate.name string

Name

Get Events by ID

Get Events by ID: Returns date for the identified event.

Parameters

Name Key Required Type Description
Get Events by ID: Returns date for the identified event.
id True string

Event ID

Returns

Name Path Type Description
Event ID
id string

Event ID

Title
title string

Title

Description
description string

Description

Event Type
type string

Event Type

Starts On
starts_at string

Starts On

Ends On
ends_at string

Ends On

Job Short Code
job.shortcode string

Job Short Code

Title
job.title string

Title

Members
members array of object

Members

Member ID
members.id string

Member ID

Name
members.name string

Name

Status
members.status string

Status

Candidate ID
candidate.id string

Candidate ID

Name
candidate.name string

Name

Get Job Activities by shortcode

Get Job Activities by shortcode: Returns the activity stream of the given job.

Parameters

Name Key Required Type Description
Get Job Activities by shortcode: Returns the activity stream of the given job.
shortcode True string

Job Short Code

Returns

Name Path Type Description
Activities
activities array of object

Activities

Activity ID
activities.id string

Activity ID

Action
activities.action string

Action

Stage name
activities.stage_name string

Stage name

Created On
activities.Created On string

Created On

Member ID
activities.member.id string

Member ID

Name
activities.member.name string

Name

Body
activities.body string

Body

Get Jobs

Get Jobs

Returns

Name Path Type Description
Jobs
jobs array of object

Jobs

Job ID
jobs.id string

Job ID

Job title
jobs.title string

Job title

Full title
jobs.full_title string

Full title

Job Short code
jobs.shortcode string

Job Short code

Code
jobs.code string

Code

State
jobs.state string

State

Sample
jobs.sample boolean

Sample

Department
jobs.department string

Department

Department hierarchy
jobs.department_hierarchy array of object

Department hierarchy

Department ID
jobs.department_hierarchy.id integer

Department ID

Department name
jobs.department_hierarchy.name string

Department name

url
jobs.url string

url

Application url
jobs.application_url string

Application url

Shortlink
jobs.shortlink string

Shortlink

Location
jobs.location.location_str string

Location

Country
jobs.location.country string

Country

Country code
jobs.location.country_code string

Country code

Region
jobs.location.region string

Region

Region Code
jobs.location.region_code string

Region Code

City
jobs.location.city string

City

Zip code
jobs.location.zip_code string

Zip code

Telecommuting
jobs.location.telecommuting boolean

Telecommuting

Created On
jobs.Created On string

Created On

Next
paging.next string

Next

Get Members

Get Members

Returns

Name Path Type Description
Members
members array of object

Members

Member ID
members.id string

Member ID

Name
members.name string

Name

Headline
members.Headline string

Headline

Email
members.email string

Email

Role
members.role string

Role

Next
paging.next string

Next

Get Stages

Get Stages

Returns

Name Path Type Description
Stages
stages array of object

Stages

Stage Slug
stages.slug string

Stage Slug

Stage name
stages.name string

Stage name

Kind
stages.kind string

Kind

Position
stages.position integer

Position

Get Subscriptions

Get Subscriptions: List all subscriptions.

Returns

Name Path Type Description
Subscriptions
subscriptions array of object

Subscriptions

Subscription ID
subscriptions.id integer

Subscription ID

Event
subscriptions.event string

Event

Target
subscriptions.target string

Target

Valid until
subscriptions.valid_until string

Valid until

Created On
subscriptions.Created On string

Created On

Stage slug
subscriptions.stage_slug string

Stage slug

Job Short Code
subscriptions.job_shortcode string

Job Short Code

Post a Subscription

Post a Subscription: Subscribe to an event.

Parameters

Name Key Required Type Description
target
target string

The URL of the endpoint to push notifications at

event
event string

One of candidate_created, candidate_moved

account_id
account_id string

The subdomain of the account

stage_slug
stage_slug string

Get notifications for specific stages. e.g. 'hired'. Not required

Returns

Name Path Type Description
id
id integer

id