Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Webhooks

Employees > Employee > Updates

Subscription_type: employees/employee/update

postWebhookWebhooks > Employees > Employee > Updates

Payload

idstring required

id of the employee.

access_idstring required

access_id associated to the employee.

first_namestring required

name of the employee.

last_namestring required

last name of the employee.

full_namestring required

full name of the employee.

preferred_namestring

nickname of the employee or a name that defines the employee better.

birth_namestring

Birthname of the employee.

genderstring

gender of the employee (male | female).

identifierstring

national identifier number.

identifier_typestring

type of identifier (ex passport).

emailstring

personal email of the employee.

login_emailstring

email associated to the session.

birthday_onstring

birthday of the employee.

nationalitystring

nationality country code of the employee (Spain ES, United Kingdom GB).

address_line_1string

address of the employee.

address_line_2string

secondary address of the employee.

postal_codestring

postal code of the employee.

citystring

city of the employee.

statestring

state/province/region of the employee.

countrystring

country code of the employee (Spain ES, United Kingdom GB).

bank_numberstring

bank account number of the employee.

swift_bicstring

code to identify banks and financial institutions globally.

bank_number_format'iban' | 'sort_code_and_account_number' | 'routing_number_and_account_number' | 'clabe' | 'other' | 'bank_name_and_account_number'

bank number format.

company_idstring required

id of the company to which the employee belongs (not editable).

legal_entity_idstring

legal entity of the employee, references to companies/legal_entities.

location_idstring required

location id of the employee, references to locations/locations.

default_work_area_idstring

Default work area ID for the employee at the default workplace. References locations/work_areas.

created_atstring required

creation date of the employee.

updated_atstring required

date of last modification of the employee

social_security_numberstring

social security number of the employee.

is_terminatingboolean required

is the employee being terminated?

terminated_onstring

termination date of the employee.

termination_reason_typestring

termination reason type of the employee

termination_reasonstring

A reason for the termination.

termination_observationsstring

observations about the termination.

manager_idstring

manager id of the employee, you can get the manager id from employees endpoint.

timeoff_manager_idstring

Timeoff manager id of the employee.

phone_numberstring

phone number of the employee.

company_identifierstring

identity number or string used inside a company to internally identify the employee.

age_numberinteger

age of the employee.

termination_type_descriptionstring

The description of the termination type.

contact_namestring

name of the employee contact.

contact_numberstring

phone number of the employee contact .

personal_emailstring

personal email of the employee.

seniority_calculation_datestring

date since when the employee is working in the company.

communications_emailstring

Confirmed email address for company communications and notifications. Separate from login email, used for internal company announcements.

unconfirmed_communications_emailstring

unconfirmed communications email address for the employee.

pronounsstring

pronouns that an employee uses to define themselves.

activeboolean

status of the employee, true when active, false when terminated.

disability_percentage_centsinteger

officially certified level of disability granted by public administration for individuals with physical or mental impairments, expressed in cents

identifier_expiration_datestring

identifier expiration date

attendableboolean required

employee included in a time tracking policy.

country_of_birthstring

Country of birth of the employee.

birthplacestring

Birthplace of the employee.

Example payload

{
  "id": "2",
  "access_id": "1",
  "first_name": "Ana",
  "last_name": "Blanco Perez",
  "full_name": "Ana Blanco Perez",
  "preferred_name": "Anita",
  "birth_name": "Anna",
  "gender": "female",
  "identifier": "QKG587532Y",
  "identifier_type": "passport",
  "email": "ana@factorial.com",
  "login_email": "ana@factorial.com",
  "birthday_on": "1990-06-06",
  "nationality": "es",
  "address_line_1": "Calle Adaro 10 1 A",
  "address_line_2": "Calle Adaro 10 1 A",
  "postal_code": "27004",
  "city": "Santander",
  "state": "Cantabria",
  "country": "es",
  "bank_number": "ES6220809324751871912999",
  "swift_bic": "CAGLES2M510",
  "bank_number_format": "iban",
  "company_id": "1",
  "legal_entity_id": "1",
  "location_id": "1",
  "default_work_area_id": "1",
  "created_at": "2010-10-06T00:00:00.000Z",
  "updated_at": "2024-10-06T00:00:00.000Z",
  "social_security_number": "150126298420",
  "terminated_on": "2024-10-06",
  "termination_reason_type": "others",
  "termination_reason": "The employee has left the company",
  "termination_observations": "Ana has been working on this project before she left",
  "manager_id": "1",
  "timeoff_manager_id": "1",
  "phone_number": "657483987",
  "company_identifier": "bb9d281e",
  "age_number": 30,
  "termination_type_description": "Baja voluntaria/Dimisión",
  "contact_name": "Laura Delgado",
  "contact_number": "647384950",
  "personal_email": "ana@factorial.com",
  "seniority_calculation_date": "2024-10-07",
  "communications_email": "employee@company.com",
  "unconfirmed_communications_email": "new-email@example.com",
  "pronouns": "She/Her",
  "active": true,
  "disability_percentage_cents": 1200,
  "identifier_expiration_date": "2023-12-31",
  "attendable": true,
  "country_of_birth": "Spain",
  "birthplace": "Barcelona"
}

Response

Return a 200 status to indicate that the data was received successfully