IMPORTANT: This documentation has been discontinued. Read the updated Gupy documentation on our new documentation portal.
What’s Gupy?
Gupy is a tool for the selections and admission of candidates. With Gupy you speed up the vacancies request, publish your opportunities in the main job portals from Brazil and qualify your candidates with dozens of ready online tests. Besides, you simplify the digital admission of new collaborators.
General Preconditions
To use the Gupy service Capsules, it’s necessary to have an authorization token, which must be registered in an ‘oauth-bearer’-type account in the Digibee Platform.
Gupy Capsules
Configuring Webhook
Through this Capsule, it’s possible to configure the requests sent to Digibee by Gupy. Different notification types, that must be sent to the pipeline whenever there’s an update in the Gupy environment, have to be configured.
The Configuring Webhook Capsule allows notification events subscriptions to be created, updated or deleted.
To configure a new webhook, just choose one of the listed events, insert the information of your pipeline and its respective API key so the Capsule can be executed.
IMPORTANT: the configuration must be made only once for each environment and desired event type.
Listing Webhooks Configurations
Use this Capsule to consult the webhooks that have been previously configured.
Listing Webhooks Configurations lists the events and the pipelines configured to receive the notifications via webhook. If it’s necessary to update or delete some information, the “id” field returned in the inquiry will serve as key field in the identification of the register to be changed. To change the configurations, use the Configuring Webhook Capsule.
Upsert Department
This Capsule allows new departments to be updated or created inside the Gupy platform.
A new register is created only if an existing department isn’t found through the search parameters informed in the “search” field. If the register already exists, then the department will be updated in the Gupy platform. The information to be updated are: “name”, “external_code” and “similar_to”.
Gupy Business Flow JOB
This Capsule has a complete flow of the job position creation in Gupy, allowing the process of positions opening requests to be automated.
The flow includes the vacancy creation, as well as its relation to the department and position.
See below the explanations for the managed entities and how they’re handled along the business flow inside the Capsule:
To ease your first Capsule use, see the required fields for the creation of a new register. In the example below, the used format is JSON:
{"job":{"roleName":"role_example: Developer","roleCode":"code_dev","roleSimilarTo":"trainee","departmentName":"Department test","departmentCode":"dep_code_eg","departmentSimilarTo":"technology","branchName":"filial xpto","branchCode":"branch_code_xpto","branchPaths":"01;02;03;04;05;06","code":"my_code_job","name":"Job name - Developer JR","type":"vacancy_type_trainee","publicationType":"internal","hiringDeadline":"2021-04-20","numVacancies":10,"description":"jobDescription - Work text text text","responsibilities":"responsibilities - text text text","prerequisites":"prerequisites - logical","additionalInformation":"additionalInformation text text","notes":"notes text text text","disabilities":false,"remoteWorking":true,"salaryCurrency":"R$","salaryStartsAt":1100.01,"salaryEndAt":null,"reason":"staff_increase","recruiterEmail":null,"managerEmail":null,"careerPageId":null,"customFields":[{"id":99,"value":"xpto"}],"jobRatingCriterias":[],"templateId":757624}}