Workable

workable

Workable is an all-in-one HR software platform that streamlines hiring, employee data management, time tracking, and payroll.

Human Resources HR Talent & Recruitment Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (21)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Delete DepartmentWORKABLE_DELETE_DEPARTMENTAcción

Tool to delete a department. use when removing an obsolete or restructured department after confirming dependent resources.

Parámetros de entrada

idstringObligatorio
Unique identifier of the department to delete.
forcestring
Set to 'DELETE' to force deletion regardless of associated resources.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get AccountWORKABLE_GET_ACCOUNTAcción

Tool to return the specified account. use when you need account metadata by subdomain after listing available accounts.

Parámetros de entrada

subdomainstringObligatorio
The subdomain of the account to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get AccountsWORKABLE_GET_ACCOUNTSAcción

Tool to retrieve a collection of all accounts you have access to. use when you need to list your workable accounts after authentication.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Background Check PackagesWORKABLE_GET_BACKGROUND_CHECK_PACKAGESAcción

Tool to retrieve a list of available background check packages from a specified provider. use after identifying the provider to view available package options.

Parámetros de entrada

providerstringObligatorio
Identifier of the background check provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Background Check ProvidersWORKABLE_GET_BACKGROUND_CHECK_PROVIDERSAcción

Tool to retrieve a list of available background check providers. use after confirming valid authentication to list integrated background check services.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CandidatesWORKABLE_GET_CANDIDATESAcción

Tool to retrieve a list of all candidates across jobs. use when you need to aggregate candidate data across your organization.

Parámetros de entrada

limitinteger
Number of candidates per page. Default is 50; maximum is 100.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get EventsWORKABLE_GET_EVENTSAcción

Tool to retrieve a collection of events scheduled in the account. use when you need to list all upcoming or past calls, interviews, or meetings.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get JobsWORKABLE_GET_JOBSAcción

Tool to retrieve a list of jobs from your workable account. use after validating account authentication before managing job postings.

Parámetros de entrada

limitinteger
Number of jobs to retrieve per page. Default is 50; maximum is 100.
statestringenum
Filter jobs by state. One of 'draft', 'published', 'archived', or 'closed'.
draftpublishedclosedarchived
max_idstring
Return results with an ID less than or equal to this value.
since_idstring
Return results with an ID greater than or equal to this value.
created_afterstring
Return results created after this ISO 8601 timestamp.
updated_afterstring
Return results updated after this ISO 8601 timestamp.
include_fieldsstring
Comma-separated list of extra fields to include in each job (e.g., 'description,full_description,requirements,benefits').

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Legal EntitiesWORKABLE_GET_LEGAL_ENTITIESAcción

Tool to retrieve a collection of your account legal entities. use after confirming valid authentication and enabling employee management.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get MembersWORKABLE_GET_MEMBERSAcción

Tool to retrieve a list of your workable account members. use after confirming valid authentication to fetch collaborators, admins, or reviewers.

Parámetros de entrada

rolestringenum
Filter members by role
adminsimplereviewerno_access
limitinteger
Max number of members to retrieve per page
max_idstring
Only return members with ID less than or equal to this value
since_idstring
Only return members with ID greater than or equal to this value
shortcodestring
Filter by job shortcode; only collaborators on that job are returned

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get recruitersWORKABLE_GET_RECRUITERSAcción

Tool to retrieve external recruiters. use when you need to fetch all external recruiters for your account after confirming the r jobs scope.

Parámetros de entrada

shortcodestring
The job's shortcode. If provided only recruiters collaborating on the correlated job will be returned.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get RequisitionsWORKABLE_GET_REQUISITIONSAcción

Tool to retrieve a collection of requisitions in the account. use after authentication succeeds.

Parámetros de entrada

limitinteger
Number of results per page. Default is 50; maximum is 100.
created_afterstring
Filter requisitions created after this timestamp (ISO8601 or Unix time).
updated_afterstring
Filter requisitions updated after this timestamp (ISO8601 or Unix time).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get StagesWORKABLE_GET_STAGESAcción

Tool to retrieve a collection of your recruitment pipeline stages. use when you need to list all available stages before managing candidates or pipelines.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SubscriptionsWORKABLE_GET_SUBSCRIPTIONSAcción

Tool to list all active subscriptions. use after verifying webhooks configuration to ensure subscriptions are active.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post Background CheckWORKABLE_POST_BACKGROUND_CHECKAcción

Tool to inject background check results directly into the candidate's timeline. use after a background check status changes to push results and attachments into workable.

Parámetros de entrada

checkobject
Structured results for a completed background check.
statusstringObligatorioenum
New status of the background check.
pendingconsentedcompleteddeclinedexpired
attachmentsobject[]
List of additional result attachments.
results_urlstringuri
Link to full report on provider's site. Required when status is 'completed'.
background_check_idstringObligatorio
Identifier of the background check request.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge DepartmentWORKABLE_POST_DEPARTMENT_MERGEAcción

Tool to merge a department into another. use after confirming both department ids and optional force flag.

Parámetros de entrada

idstringObligatorio
The ID of the department to be merged (source department).
forceboolean
Whether to force the merge, overriding any conflicts.
target_department_idstringObligatorio
The ID of the target department to merge into.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create DepartmentWORKABLE_POST_DEPARTMENTSAcción

Tool to create a department in your account. use when you need to add a new department for organizing teams under your workable account.

Parámetros de entrada

namestringObligatorio
The name of the department.
parent_idstring
Identifier of the parent department, or null for top-level departments.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Enable MemberWORKABLE_POST_MEMBER_ENABLEAcción

Tool to restore a deactivated member. use after confirming the member is currently deactivated.

Parámetros de entrada

idstringObligatorio
The ID of the member to restore.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Invite MemberWORKABLE_POST_MEMBERS_INVITEAcción

Tool to invite a member to your workable account. use when sending an invitation email.

Parámetros de entrada

rolestringObligatorioenum
Role to assign to the invited member. Possible: admin, simple, reviewer, no_access.
adminsimplereviewerno_access
emailstringObligatorio
Email address to send the invitation to.
hris_rolestringenum
HRIS role for the invited member if Workable HR is enabled. Possible: hris_admin, hris_employee, hris_no_access.
hris_adminhris_employeehris_no_access
member_idstring
Identifier of the existing member sending the invitation. Required when using an account-wide access token.
collaboration_rulesobject[]
Array of collaboration rules to apply to the invited member.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DepartmentWORKABLE_PUT_DEPARTMENTSAcción

Tool to update an existing department in your account. use when renaming a department or changing its parent after confirming its id.

Parámetros de entrada

idstringObligatorio
Identifier of the department to update.
namestring
New department name. Include only when renaming.
parent_idstring
Identifier of the new parent department, or null for top-level.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update MemberWORKABLE_PUT_MEMBERSAcción

Tool to update a member's details. use when you need to modify information of an existing member after confirming the id.

Parámetros de entrada

idstringObligatorio
The unique identifier of the member to be updated.
namestring
The full name of the member.
rolestringenum
The member's role. Possible values: 'admin', 'simple', 'reviewer', 'no_access'.
adminsimplereviewerno_access
emailstring
The email address of the member.
headlinestring
The headline or job title of the member.
hris_rolestringenum
The member's HRIS role. Possible values: 'hris_admin', 'hris_employee', 'hris_no_access'.
hris_adminhris_employeehris_no_access
collaboration_rulesobject[]
An array of collaboration rules assigned to the member.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not