This event is triggered every time a pre-employee moves between the stages of the admission process (including the “Admission Concluded” stage).
This event is commonly used in Gupy Admissão integrations with payroll systems. For more information on how to perform this integration, please refer to our model available here
Constants
The following ids represent the dependent type ids:
| ID | Dependent Type |
|---|---|
| a93534d0-2337-4a1a-8533-013aaf826732 | Cônjuge |
| 164a646f-cc83-462e-8f83-f206703d6843 | Companheiro(a) com o(a) qual tenha filho ou viva há mais de 5 (cinco) anos ou possua declaração de união estável. |
| 3808db5b-b808-4cf0-97c6-9ac15cc98125 | Filho(a) ou enteado(a). |
| 4360f57d-bce0-49eb-90f7-e4d0d680e045 | Filho(a) ou enteado(a), universitário(a) ou cursando escola técnica de 2º grau. |
| 94a1ba31-e6a4-49ce-8d6f-f92630e49a9c | Irmão(ã), neto(a) ou bisneto(a) sem arrimo dos pais, do(a) qual detenha a guarda judicial. |
| d8e32995-e253-43d8-b632-b4317b21ee97 | Irmão(ã), neto(a) ou bisneto(a) sem arrimo dos pais, universitário(a) ou cursando escola técnica de 2º grau, do(a) qual detenha a guarda judicial. |
| bd1254c0-21b8-4b72-9152-c4ff41402f47 | Pais, avós e bisavós. |
| b8a3e77a-fcf1-40ea-80cf-aea313969043 | Menor pobre do qual detenha a guarda judicial. |
| b0264e29-fa41-454e-8a06-8de38b7a9e68 | Pessoa absolutamente incapaz, da qual seja tutor ou curador. |
| 91b0dbdb-af59-41af-85a2-3e405a8393e6 | Ex-cônjugue. |
| dc3d82da-0908-45df-9324-b7175ed013a1 | Agregados/outros. |
Notification properties
The notification will be sent with the following properties:
Property | Type | Description |
|---|---|---|
job | object | Basic job information |
↳ id | integer/null | Job identifier (this attribute will be null only for pre-employees inserted directly in Gupy Admissão) |
↳ code | string | Job posting code |
↳ name | string | Job name |
↳ department | object | Job department information (id, name, code and similarity) |
↳ role | object | Job role information (id, name, code and similarity) |
↳ branch | object/null | Job branch (id, name and code) |
↳ customFields | array | Custom fields of job (this attribute will always be an empty array for pre-employees inserted directly in Gupy Admissão) |
↳↳id | string | Custom field id |
↳↳title | string | Custom field title |
↳↳value | string | Custom field value (if value is filled, otherwise this field will not be available) |
application | object/null | Application information (this attribute will be null only for pre-employees inserted directly in Gupy Admissão) |
↳ id | number | Application identifier |
↳ score | double | Score of the candidate given by the Gupy platform |
↳ preHiringInformation | object | Pre-hiring step information (if this step is used in the job) |
↳ tags | array | Tags applied to the application |
↳ currentStep | object | Current step of the application |
↳ ↳ id | string | Step identifier |
↳ ↳ name | string | Step name |
candidate | object | Candidate information |
↳ name | string | Candidate name |
↳ lastName | string | Candidate last name |
string | Candidate e-mail | |
↳ identificationDocument | string/null | The identification document of the candidate, In Brazil, this refers to the CPF number. This information will be null for pre-employees inserted directly in Gupy Admissão until the pre-employee accepts the invitation to the process. |
↳ countryOfOrigin | string/null | Country of origin of the candidate (eg. Brasil) |
↳ birthdate | string/null | Birth date of the candidate |
↳ addressZipCode | string/null | Address zip code |
↳ addressStreet | string/null | Address street name |
↳ addressNumber | string/null | Address number/complement |
↳ addressCity | string/null | Address city |
↳ addressState | string/null | Address state full name |
↳ addressStateShortName | string/null | Address state short name (eg. SP) |
↳ addressCountry | string/null | Address country |
↳ addressCountryShortName | string/null | Country short name (eg. BR) |
↳ mobileNumber | string/null | Mobile phone number |
↳ phoneNumber | string/null | Phone number |
↳ schooling | string/enum/null | Candidate schooling |
↳ schoolingStatus | string/enum/null | Candidate schooling status |
↳ disabilities | boolean | Candidate is a person with disabilities |
↳ gender | string/enum/null | Candidate gender (Male, Female, Other, NotInformed) |
user | object | Person who moves the pre-employee to other step (empty when moves automatically) |
↳ id | number | Identifier of the person who moves the pre-employee |
↳ name | string | Name of the person who moves the pre-employee |
string | Email of the person who moves the pre-employee | |
preEmployee | object | Pre-employee's admission process info |
↳ id | number | Pre-employee's identifier |
↳ fullName | string | Pre-employee full name |
↳ status | string | Current admission status id (current step in the admission process) |
↳ statusName | string | Current admission status name (current step in the admission process) |
↳ previousStatus | string | Previous admission status id (previous step in the admission process) |
↳ previousStatusName | string | Previous admission status name (previous step in the admission process) |
↳ hiringDate | string | Date which a pre-employee started the admission process |
↳ admissionDeadline | string | Date that blocks a pre-employee from sending documents. (default of 7 days after hiringDate) |
↳ documentsTemplate | object | An object containing information from a template of documents used in an admission process of a pre-employee |
↳↳ id | number | template of documents id |
↳↳ name | string | Available only after pre-employee accepted the admission process invite |
↳ documents | object | An object with all informed documents (from pre-employee and its dependents, if available). |
↳↳ preEmployee | array | A list of all documents from employee |
↳↳↳ id | number/string | The document id |
↳↳↳ name | string | The document name |
↳↳↳ values | object | An object with document fields |
↳↳↳ schema | object | The base schema from document |
↳↳↳↳ id | integer | Schema identifier |
↳↳↳↳ name | string | Schema name |
↳↳↳↳ companyId | integer/null | Identifier of the company that created the document. Gupy default documents will be null |
↳↳↳↳additionalProperties | object/null | An object listing all additional properties of the schema |
↳↳↳↳ uiSchema (deprecated) | object | An object listing all UI properties of the schema |
↳↳↳↳ schema | object | The second level schema from document |
↳↳↳↳↳ required | array | A list of all required fields from schema |
↳↳↳↳↳ properties | object | An object listing all field types and names |
↳↳↳↳↳description | string | An optional description of the schema |
↳↳↳↳↳dependencies | object | An object listing the possible dependencies of the schema |
↳↳↳↳↳definitions | object | An object listing the possible definitions of the schema |
↳↳↳ validation | object | The validation of a document |
↳↳↳ missing | boolean | Tells whether a pre-employee has the document or not |
↳↳ dependents | array | A list of all pre-employee's dependents |
↳↳↳ name | string | The dependent name |
↳↳↳ dependentTypeId | string | The dependent type id. |
↳↳↳ documents | array | A list of all documents from this dependent. Follows the same structure as admission.documents.preEmployee. |
↳↳ steps | array | A list of all steps with forms that a pre-employee filled |
↳↳↳ stepName | string | The name of step |
↳↳↳ forms | array | Filled form with pre-employee data |
↳↳↳ triggerStep | boolean | Indicative that the step is an integration trigger |
↳ position | object | An object contain all information related to current admission position |
↳↳ positionId | number | id of position |
↳↳ integratingAgent | string/null | Position integration agent |
↳↳ contractEndDate | Date/null | Contract end date |
↳↳ paymentRecurrence | string/null | Position payment recurrence |
↳↳ registration | string/null | Position registration |
↳↳salary | object | Salary |
↳↳↳value | number/null | Salary value |
↳↳↳currency | string/null | Salary currency (e.g.: R$, $, £, €) |
↳↳branch | object | Position branch (id, name and code) |
↳↳department | object | Position department information (id, name and code) |
↳↳role | object | Position role information (id, name and code) |
↳↳costCenter | object | An object contain all information related to current admission position cost center |
↳↳↳id | string | Cost center id |
↳↳↳name | string | Cost center name |
↳↳↳code | string | Cost center code |
↳↳↳branch | object | Cost center branch (id, label and code) |
↳↳↳department | object | Cost center department information (id, name and cod |
↳↳workShift | object | An object contain all information related to current admission position work shift |
↳↳↳id | string | Work shift id |
↳↳↳name | string | Work shift name |
↳↳↳code | string | Work shift code |
↳↳↳description | string | Work shift description |
↳↳↳workload | string | Work shift workload |
↳↳ customFields | array | Custom fields of position |
↳↳↳id | string | Custom field id |
↳↳↳title | string | Custom field title |
↳↳↳value | string | Custom field value (if value is filled, otherwise this field will not be available) |
↳↳↳isIntegrated | boolean | Custom field integration flag |
benefitsEnabled | boolean | Benefits feature activate flag |
benefits | object | Pre-employee's benefits info |
↳contracts | array | List of pre employee’s benefits adherence contracts |
↳↳id | string | Benefits adherence contract id |
↳↳name | string | Benefits adherence contract name |
↳transportVoucher | object | Benefit transport voucher info |
↳↳id | number/null | Benefit transport voucher id |
↳↳title | string/null | Benefit transport voucher title |
↳↳type | string/null | Benefit transport voucher type (optional or mandatory) |
↳↳needSignature | boolean/null | Benefit transport voucher signature flag |
↳↳description | string/null | Benefit transport voucher description |
↳↳termAndCondition | string/null | Benefit transport voucher term and condition (true or false) |
↳↳reasonForNotWanting | string/null | Benefit transport voucher reason for not wanting (when the pre employee does not adhere to the benefit) |
↳↳modality | string/null | Benefit transport voucher modality (Ônibus, Trem or Metrô) |
↳↳amountDay | string/null | Benefit transport voucher amount day |
↳↳itinerary | string/null | Benefit transport voucher itinerary |
↳dentalPlan | object | Benefit dental plan info |
↳↳id | number/null | Benefit dental plan id |
↳↳title | string/null | Benefit dental plan title |
↳↳type | string/null | Benefit dental plan type (optional or mandatory) |
↳↳needSignature | boolean/null | Benefit dental plan signature flag |
↳↳description | string/null | Benefit dental plan description |
↳↳termAndCondition | string/null | Benefit dental plan term and condition (true or false) |
↳↳includeDependents | string/null | Benefit dental plan term include dependents flag (Sim or Não) |
↳↳dependents | array | Benefit dental plan dependents |
↳↳↳id | number | Benefit dental plan dependent id |
↳healthAssurance | object | Benefit health assurance info |
↳↳id | number/null | Benefit health assurance id |
↳↳title | string/null | Benefit health assurance title |
↳↳type | string/null | Benefit health assurance type (optional or mandatory) |
↳↳needSignature | boolean/null | Benefit health assurance signature flag |
↳↳description | string/null | Benefit health assurance description |
↳↳termAndCondition | string/null | Benefit health assurance term and condition (true or false) |
↳↳includeDependents | string/null | Benefit health assurance term include dependents flag (Sim or Não) |
↳↳dependents | array | Benefit health assurance dependents |
↳↳↳id | number | Benefit health assurance dependent id |
↳lifeAssurance | object | Benefit life assurance info |
↳↳id | number/null | Benefit life assurance id |
↳↳title | string/null | Benefit life assurance title |
↳↳type | string/null | Benefit life assurance type (optional or mandatory) |
↳↳needSignature | boolean/null | Benefit life assurance signature flag |
↳↳description | string/null | Benefit life assurance description |
↳↳termAndCondition | string/null | Benefit life assurance term and condition (true or false) |
↳↳beneficiaries | array | Benefit life assurance beneficiaries list |
↳↳↳name | string | Benefit life assurance beneficiary name |
↳↳↳percentageOfParticipation | string | Benefit life assurance beneficiary percentage of participation |
↳↳↳relationship | string | Benefit life assurance beneficiary relationship |
↳foodAndMeal | object | Benefit food and meal info |
↳↳id | number/null | Benefit food and meal id |
↳↳title | string/null | Benefit food and meal title |
↳↳type | string/null | Benefit food and meal type (optional or mandatory) |
↳↳needSignature | boolean/null | Benefit food and meal signature flag |
↳↳description | string/null | Benefit food and meal description |
↳↳termAndCondition | string/null | Benefit food and meal term and condition (true or false) |
↳↳offerOptions | string/null | Benefit food and meal offer options (Vale refeição + Vale alimentação, Vale refeição or Vale alimentação) |
↳↳observation1 | string/null | First benefit food and meal observation |
↳↳observation2 | string/null | Second benefit food and meal observation |
↳other | array | Benefit other infos |
↳↳id | number | Benefit other id |
↳↳title | string | Benefit other title |
↳↳type | string | Benefit other type (optional or mandatory) |
↳↳needSignature | boolean | Benefit other signature flag |
↳↳description | string | Benefit other description |
↳↳termAndCondition | string | Benefit other term and condition (true or false) |
↳↳observation1 | string | First benefit other observation |
↳↳observation2 | string | Second benefit other observation |
{
"companyName": "ACME",
"id": "24e99765-8583-4be5-87ae-489c86642964",
"event": "pre-employee.moved",
"date": "2019-06-19T23:48:46.952Z",
"data": {
"job": {
"id": 19139,
"code": "code-19139",
"name": "Developer",
"department": {
"id": 45,
"code": "45124",
"name": "App Development",
"similarity": "technology"
},
"role": {
"id": 56,
"code": "123456",
"name": "Developer",
"similarity": "developer"
},
"branch": {
"id": 1895,
"code": "1234",
"name": "GUPY > BRANCH 1"
},
"customFields": [
{
"id": "7bd3b8ba-180b-4ae2-b397-240f8fb249c6",
"title": "Pergunta",
"value": "Resposta"
}
]
},
"application": {
"id": 2937132,
"score": 71.570454783086,
"preHiringInformation": {
"key1": "value1",
"key2": "value2"
},
"tags": [
"tag1"
],
"currentStep": {
"id": 86547,
"name": "Pré-contratação"
}
},
user: {
id: 1215163,
name: "Janaina Silva",
email: "[email protected]",
},
"candidate": {
"id": 1999450,
"name": "John",
"lastName": "Doe",
"email": "[email protected]",
"identificationDocument": "25272626207",
"countryOfOrigin": "Brasil",
"birthdate": "1994-11-16",
"addressZipCode": "01414-905",
"addressStreet": "Rua Haddock Lobo",
"addressNumber": "595 - 10º andar",
"addressCity": "São Paulo",
"addressState": "São Paulo",
"addressStateShortName": "SP",
"addressCountry": "Brasil",
"addressCountryShortName": "BR",
"mobileNumber": "+5511999990000",
"phoneNumber": "+551130000000",
"schooling": "technical_course",
"schoolingStatus": "complete",
"disabilities": false,
"gender": "Male"
},
"benefitsEnabled": true,
"benefits": {
"contracts": [
{
"id": "48fd89f7-7457-4ff3-b26d-0c5956b51a40",
"name": "Contrato de adesão ao benefício de plano odontológico"
},
{
"id": "269228a3-422a-4d6c-8ce0-cc2f82100ae7",
"name": "Contrato de adesão ao benefício de seguro de vida"
}
],
"transportVoucher": {
"id": null,
"title": null,
"type": null,
"needSignature": null,
"description": null,
"termAndCondition": null,
"reasonForNotWanting": null,
"modality": null,
"amountDay": null,
"itinerary": null
},
"dentalPlan": {
"id": 6045,
"title": "Plano dental 340",
"type": "optional",
"needSignature": true,
"description": "Descrição do plano odontológico",
"termAndCondition": "true",
"includeDependents": "Sim",
"dependents": [
{
"id": 8369
}
]
},
"healthAssurance": {
"id": null,
"title": null,
"type": null,
"needSignature": null,
"description": null,
"termAndCondition": null,
"includeDependents": null,
"dependents": []
},
"lifeAssurance": {
"id": 6046,
"title": "Beneficio seguro de vida",
"type": "optional",
"needSignature": true,
"description": "Descrição do benefício de seguro de vida",
"termAndCondition": "true",
"beneficiaries": [
{
"name": "Pedro",
"percentageOfParticipation": "50",
"relationship": "Filho(a)"
},
{
"name": "Henrique",
"percentageOfParticipation": "50",
"relationship": "Filho(a)"
}
]
},
"foodAndMeal": {
"id": null,
"title": null,
"type": null,
"needSignature": null,
"description": null,
"termAndCondition": null,
"offerOptions": null,
"observation1": null,
"observation2": null
},
"other": [
{
"id": 5987,
"title": "Beneficio Outros",
"type": "optional",
"needSignature": true,
"description": "<p>Beneficio Outros</p>",
"termAndCondition": null,
"observation1": null,
"observation2": null
},
{
"id": 5990,
"title": "Beneficio Outros 2",
"type": "mandatory",
"needSignature": false,
"description": "<p>Beneficio outros 2</p>",
"termAndCondition": "true",
"observation1": "Qualquer observação 1",
"observation2": "Qualquer observação 2"
},
{
"id": 5989,
"title": "Beneficio Outros 4",
"type": "optional",
"needSignature": true,
"description": "<p>Beneficio outros 4</p>",
"termAndCondition": "true",
"observation1": "Qualquer observação 1",
"observation2": "Qualquer observação 2"
},
]
},
"admission": {
"status": "SIGNING_CONTRACT",
"admissionDeadline": "2019-06-26T00:00:00.000",
"hiringDate": "2019-06-19T00:00:00.000Z",
"documentsTemplate": {
"id": 1,
"name": "List of Documents"
},
"documents": {
"preEmployee": [
{
"id": 1,
"name": "CNH",
"values": {
"name": "Pre-Employee",
"number": 1313213
},
"validation": {
"status": "APPROVED",
"validatedAt": "2020-09-17T22: 49: 10.981Z",
"companyUserId": 1
},
"schema": {
"id": 1,
"name": "CNH",
"companyId": null,
"additionalProperties": {
"additionalProperty1": {
"attribute": true
}
},
"uiSchema": {
"name": {
"ui:field": "text",
"ui:options": {
"option1": true,
"option2": [
"value1",
"value2",
"value3"
],
"option3": {
"attribute1": "value1",
"attribute2": 2
}
},
"ui:help": "text"
},
"number": {
"ui:field": "number"
},
"ui:order": [
"name",
"number"
]
},
"schema": {
"required": [
"name",
"number"
],
"properties": {
"name": {
"type": "string",
"title": "Nome Completo"
},
"number": {
"type": "number",
"title": "Número da CNH"
}
},
"description": "",
"dependencies": {},
"definitions": {}
}
},
"missing": false
},
{
"id": 2,
"name": "Comprovante de residência",
"schema": {
"id": 2,
"name": "Comprovante de residência",
"companyId": null,
"additionalProperties": {
"isCity": {
"cidade": true
},
"isState": {
"estado": true
},
"isCountry": {
"pais": true
}
},
"uiSchema": {
"cep": {
"ui:field": "text",
"ui:options": {
"mask": [
"[0-9]",
"[0-9]",
"[0-9]",
"[0-9]",
"[0-9]",
"-",
"[0-9]",
"[0-9]",
"[0-9]"
],
"exactLength": {
"title": "CEP",
"expectedLength": 8
}
}
},
"pais": {
"ui:field": "select"
},
"tipo": {
"ui:field": "select"
},
"bairro": {
"ui:field": "text"
},
"cidade": {
"ui:field": "select"
},
"estado": {
"ui:field": "select"
},
"numero": {
"ui:field": "houseNumber"
},
"ui:order": [
"tipo",
"logradouro",
"numero",
"complemento",
"bairro",
"pais",
"estado",
"cidade",
"cep"
],
"logradouro": {
"ui:field": "text"
},
"complemento": {
"ui:field": "text"
}
},
"schema": {
"required": [
"tipo",
"logradouro",
"numero",
"bairro",
"cidade",
"estado",
"cep",
"pais"
],
"properties": {
"cep": {
"type": "string",
"title": "CEP",
"description": "00000-000"
},
"pais": {
"type": "string",
"title": "País"
},
"tipo": {
"enum": [],
"type": "string",
"title": "Tipo"
},
"bairro": {
"type": "string",
"title": "Bairro"
},
"cidade": {
"type": "string",
"title": "Cidade"
},
"estado": {
"type": "string",
"title": "Estado"
},
"numero": {
"type": [
"string",
"null"
],
"title": "Número"
},
"logradouro": {
"type": "string",
"title": "Logradouro (ex: nome da rua)"
},
"complemento": {
"type": "string",
"title": "Complemento"
}
},
"definitions": {},
"dependencies": {}
}
}
}
],
"dependents": [
{
"name": "Dependente 1",
"dependentTypeId": "3808db5b-b808-4cf0-97c6-9ac15cc98125",
"documents": [
{
"id": null,
"name": "Dados do dependente",
"values": {
"cpf": "12345678900",
"name": "Dependente 1"
},
"validation": null,
"missing": false,
"schema": {
"id": null,
"name": "Dados do dependente",
"companyId": null,
"additionalProperties": {},
"uiSchema": {
"name": {
"ui:field": "text"
},
"cpf": {
"ui:field": "text"
},
"ui:order": [
"name",
"cpf"
]
},
"schema": {
"required": [
"name",
"cpf"
],
"properties": {
"name": {
"type": "string",
"title": "Nome"
},
"cpf": {
"type": "string",
"title": "CPF"
}
},
"description": "",
"dependencies": {},
"definitions": {}
}
}
}
]
}
],
"steps": [
{
"stepName": "Benefícios",
"triggerStep": true,
"forms": [
{
"id": null,
"name": "Plano de Saúde",
"values": {
"cpf": "12345678900",
"name": "Fulano de Tal"
},
"validation": null,
"missing": false,
"schema": {
"id": null,
"name": "Plano de Saúde",
"companyId": null,
"additionalProperties": {},
"uiSchema": {
"name": {
"ui:field": "text"
},
"cpf": {
"ui:field": "text"
},
"ui:order": [
"name",
"cpf"
]
},
"schema": {
"required": [
"name",
"cpf"
],
"properties": {
"cpf": {
"type": "string",
"title": "CPF"
},
"name": {
"type": "string",
"title": "Nome"
}
}
}
}
}
]
}
]
},
"position": {
"positionId": 1000,
"integratingAgent": "senai",
"contractEndDate": "2023-10-31T03:00:00.000Z",
"paymentRecurrence": "mensalista",
"registration": "123321",
"salary": {
"value": 1250.5,
"currency": "R$"
},
"department": {
"id": 1,
"code": "1234",
"name": "Development"
},
"role": {
"id": 523,
"code": "44322",
"name": "Developer"
},
"branch": {
"id": 3321,
"code": "123",
"label": "BRANCH > BRANCH 1"
},
"customFields": [
{
"id": "7bd3b8ba-180b-4ae2-b397-240f8fb249c6",
"title": "Pergunta",
"value": "Resposta",
"isIntegrated": true
}
],
"costCenter": {
"id": 448,
"code": "CODCENCOST",
"name": "NomeCentroCustoXYZ",
"department": {
"id": 19605,
"code": null,
"name": "Area 1"
},
"branch": {
"id": 116304,
"code": "ARAPIRACA",
"label": "BRANCH > ARAPIRACA"
}
},
"workShift": {
"id": 3,
"code": "TURNO 2",
"name": "Teste Turno",
"description": "Descrição",
"workload": "180",
"letter": "ABC"
}
}
}
}
}