Employees > Employee > Invites

wbhk Webhooks > Employees > Employee > Invites

Subscription_type: employees/employee/invite

payload

Callback payload

integer

required

id of the employee.

access_id

integer

required

access_id associated to the employee.

first_name

string

required

name of the employee.

last_name

string

required

last name of the employee.

full_name

string

required

full name of the employee.

preferred_name

string

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

birth_name

string

Birthname of the employee.

gender

string

gender of the employee (male | female).

identifier

string

national identifier number.

identifier_type

string

type of identifier (ex passport).

string

personal email of the employee.

login_email

string

email associated to the session.

birthday_on

string

birthday of the employee.

nationality

string

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

address_line_1

string

address of the employee.

address_line_2

string

secondary address of the employee.

postal_code

string

postal code of the employee.

city

string

city of the employee.

state

string

state/province/region of the employee.

country

string

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

bank_number

string

bank account number of the employee.

swift_bic

string

code to identify banks and financial institutions globally.

bank_number_format

string

bank number format.

company_id

integer

required

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

legal_entity_id

integer

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

location_id

integer

required

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

created_at

string

required

creation date of the employee.

updated_at

string

required

date of last modification of the employee

social_security_number

string

social security number of the employee.

is_terminating

boolean

required

is the employee being terminated?

terminated_on

string

termination date of the employee.

termination_reason_type

string

termination reason type of the employee

termination_reason

string

A reason for the termination.

termination_observations

string

observations about the termination.

manager_id

integer

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

timeoff_manager_id

integer

Timeoff manager id of the employee.

phone_number

string

phone number of the employee.

company_identifier

string

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

age_number

integer

age of the employee.

termination_type_description

string

The description of the termination type.

contact_name

string

name of the employee contact.

contact_number

string

phone number of the employee contact .

personal_email

string

personal email of the employee.

seniority_calculation_date

string

date since when the employee is working in the company.

pronouns

string

pronouns that an employee uses to define themselves.

active

boolean

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

disability_percentage_cents

integer

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

identifier_expiration_date

string

identifier expiration date

Response

200

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

Payload

Choose an example