Guides
PeopleForce Login

Employee profile

Suggest Edits

An employee profile is an account of the employee. To log in to the system your employee might be using the email or Active Directory Username, so be careful changing these fields.

Employee profile supports following webhooks

  • Employee profile created
  • Employee profile updated
  • Employee first day
  • Employee terminated

Employee profile created

Webhook will be triggered instantly, as soon as the user has created a new employee profile.
Action: 'employee_create'
Payload example:

{
  "action": "employee_create",
  "data": {
    "id": 133710,
    "attributes": {
      "employee_number": "IT-1029",
      "hired_on": "2022-09-26",
      "probation_ends_on": "2022-12-26",
      "first_name": "Volodymyr",
      "last_name": "Markovich",
      "email": "[email protected]",
      "personal_email": null,
      "gender": "male",
      "mobile_number": "",
      "work_phone_number": "",
      "date_of_birth": "1978-08-29",
      "termination_effective_date": null,
      "termination_comment": null,
      "avatar_url": null
    },
    "reporting_to": {
      "id": 10277,
      "full_name": "Zhelezo Pahney",
      "email": "[email protected]"
    },
    "employment_type": {
      "id": 1899,
      "name": "Full-Time"
    },
    "position": {
      "id": 114651,
      "name": "IT Support Engineer"
    },
    "department": {
      "id": 5094,
      "name": "IT"
    },
    "division": {
      "id": 1819,
      "name": "Europe"
    },
    "location": {
      "id": 28693,
      "name": "Vinnytsia"
    },
    "custom_fields": {
      "ccbf050d-ec5c-4c57-8905-9eb80cb443eb": {
        "name": "1",
        "value": null,
        "group": "1"
      },
      "a25b06fb-bcfb-4aac-b695-6aff138fac36": {
        "name": "HR manager",
        "value": "5844",
        "group": "Personal"
      }
    },
    "meta": {
      "created_at": "2022-09-21T16:29:07.894+03:00",
      "updated_at": "2022-09-21T16:29:08.713+03:00"
    }
  }
}

Employee profile updated

Webhook will be triggered instantly, as soon as the user has updated an existing employee profile.
Action: 'employee_update'
Payload example:

{
  "action": "employee_update",
  "data": {
    "id": 133710,
    "attributes": {
      "employee_number": "IT-1029",
      "hired_on": "2022-09-26",
      "probation_ends_on": "2022-12-26",
      "first_name": "Volodymyr",
      "last_name": "Markovich",
      "email": "[email protected]",
      "personal_email": "[email protected]",
      "gender": "male",
      "mobile_number": "",
      "work_phone_number": "",
      "date_of_birth": "1978-08-29",
      "termination_effective_date": null,
      "termination_comment": null,
      "avatar_url": null
    },
    "reporting_to": {
      "id": 10277,
      "full_name": "Zhelezo Pahney",
      "email": "[email protected]"
    },
    "employment_type": {
      "id": 1899,
      "name": "Full-Time"
    },
    "position": {
      "id": 114651,
      "name": "IT Support Engineer"
    },
    "department": {
      "id": 5094,
      "name": "IT"
    },
    "division": {
      "id": 1819,
      "name": "Europe"
    },
    "location": {
      "id": 28693,
      "name": "Vinnytsia"
    },
    "custom_fields": {
      "ccbf050d-ec5c-4c57-8905-9eb80cb443eb": {
        "name": "1",
        "value": null,
        "group": "1"
      },
      "a25b06fb-bcfb-4aac-b695-6aff138fac36": {
        "name": "HR manager",
        "value": "5844",
        "group": "Personal"
      }
    },
    "meta": {
      "created_at": "2022-09-21T16:29:07.894+03:00",
      "updated_at": "2022-09-21T16:41:40.351+03:00"
    }
  }
}

Employee first day

Webhook will be triggered in a couple of cases:

  1. Instantly if an employee is created and the hire date is today
  2. Every night at 1 am (UTC +0) and push all the employees that have the hire date today
    Action: 'employee_start'
    Payload example:
{
  "action": "employee_start",
  "data": {
    "id": 133710,
    "attributes": {
      "employee_number": "IT-1029",
      "hired_on": "2022-09-12",
      "probation_ends_on": "2022-12-12",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "personal_email": null,
      "gender": "male",
      "mobile_number": "",
      "work_phone_number": "",
      "date_of_birth": "1978-08-31",
      "termination_effective_date": null,
      "termination_comment": null,
      "avatar_url": null
    },
    "reporting_to": {
      "id": 5844,
      "full_name": "Ross Kate",
      "email": "[email protected]"
    },
    "employment_type": {
      "id": 1899,
      "name": "Full-Time"
    },
    "position": {
      "id": 11943,
      "name": "Senior Developer"
    },
    "department": {
      "id": 5094,
      "name": "IT"
    },
    "division": {
      "id": 1819,
      "name": "Europe"
    },
    "location": null,
    "custom_fields": {
      "ccbf050d-ec5c-4c57-8905-9eb80cb443eb": {
        "name": "1",
        "value": null,
        "group": "1"
      },
      "a25b06fb-bcfb-4aac-b695-6aff138fac36": {
        "name": "HR manager",
        "value": "5844",
        "group": "Personal"
      }
    },
    "meta": {
      "created_at": "2022-09-05T15:33:55.130Z",
      "updated_at": "2022-09-05T15:33:55.526Z"
    }
  }
}

Employee activated

This webhook will be triggered instantly in 2 cases:

  1. When an employee termination was cancelled (before employee termination date occur)
  2. When a terminated employee was "reactivated", which means that their termination was reverted and employee is not terminated anymore.
{
  "action": "employee_activate",
  "data": {
    "id": 123599,
    "attributes": {
      "employee_number": "",
      "hired_on": "2022-07-29",
      "probation_ends_on": null,
      "first_name": "John",
      "last_name": "Doe",
      "email": "",
      "personal_email": "",
      "gender": "male",
      "gender_id": 245,
      "mobile_number": "",
      "work_phone_number": "",
      "date_of_birth": null,
      "termination_effective_date": null,
      "termination_comment": null,
      "avatar_url": null
    },
    "reporting_to": null,
    "employment_type": null,
    "position": null,
    "job_level": null,
    "department": null,
    "division": null,
    "location": null,
    "custom_fields": {
      "ccbf050d-ec5c-4c57-8905-9eb80cb443eb": {
        "name": "1",
        "value": null,
        "group": "1"
      },
      "a25b06fb-bcfb-4aac-b695-6aff138fac36": {
        "name": "HR manager",
        "value": "5844",
        "group": "Personal"
      }
    },
    "meta": {
      "created_at": "2022-07-29T15:59:24.200+01:00",
      "updated_at": "2024-02-01T16:07:41.997+00:00"
    }
  }
}

Employee terminated

Webhook will be triggered in a couple of cases:

  1. Instantly if an employee is terminated with the past date
  2. Every night at 1 am (UTC +0) and push all the employees that have the hire date today
    Action: 'employee_terminate'
    Payload example:
{
  "action": "employee_terminate",
  "data": {
    "id": 123512,
    "attributes": {
      "employee_number": "IT-1029",
      "hired_on": "2022-07-26",
      "probation_ends_on": null,
      "first_name": "John",
      "last_name": "Doe",
      "email": null,
      "personal_email": null,
      "gender": null,
      "mobile_number": "",
      "work_phone_number": "",
      "date_of_birth": null,
      "termination_effective_date": "2022-11-07",
      "termination_comment": "",
      "avatar_url": null
    },
    "reporting_to": null,
    "employment_type": null,
    "position": null,
    "department": null,
    "division": null,
    "location": null,
   "custom_fields": {
      "ccbf050d-ec5c-4c57-8905-9eb80cb443eb": {
        "name": "1",
        "value": null,
        "group": "1"
      },
      "a25b06fb-bcfb-4aac-b695-6aff138fac36": {
        "name": "HR manager",
        "value": "5844",
        "group": "Personal"
      }
    },
    "meta": {
      "created_at": "2022-07-29T10:42:43.354+01:00",
      "updated_at": "2022-11-10T11:12:32.102+00:00"
    }
  }
}

Updated 11 months ago