⚠️ Available in Professional package. Interested? Please e-mail us at sales@peopleforce.io to find out more.
The Webhooks API allows you to subscribe to events happening in PeopleForce with the integration of your choice as long as it supports webhooks. Rather than making an API call when an event happens, PeopleForce can send an HTTP request to an endpoint you configure. You can configure subscribed events in your PeopleForce Settings. Additionally, you can view all the deliveries that happened and what data they passed.
Learn more about how to set up a webhook and see execution history in our guide on Getting started with webhooks.
PeopleForce has a variety of webhooks, all of them listed below. Webhook events availability depends on your selected PeopleForce modules.
Employee:
Employee created - webhook will be triggered instantly, as soon as the user has created a new employee profile.
Employee updated - webhook will be triggered instantly, as soon as the user has updated an existing employee profile.
Employee first date - webhook will be triggered in a couple of cases:
Instantly if an employee is created and the hire date is today;
Every night at 1 am (UTC +0) and push all the employees that have the hire date today.
Employee activated - webhook will be triggered instantly in 2 cases:
When an employee termination was cancelled (before the employee termination date occurred);
When a terminated employee was "reactivated", which means that their termination was reverted and the employee is not terminated anymore.
Employee terminated - webhook will be triggered in a couple of cases:
Instantly if an employee is terminated with the past date;
Every night at 1 am (UTC +0) and push all the employees that have the hire date today.
Employee termination reverted - will be triggered every time the employee termination was reverted.
Employee position created - webhook will be triggered immediately whenever a new position record is added to any employee: active or terminated (inactive).
Employee position updated - webhook will be triggered immediately whenever an existing position record is updated for any employee: active or terminated (inactive).
Employee salary created - webhook will be triggered immediately whenever a new salary record is added to any employee: active or terminated (inactive).
Employee salary updated - webhook will be triggered immediately whenever an existing salary record is edited for any employee: active or terminated (inactive).
Leave requests:
Leave request created - webhook will be triggered instantly, as soon as the leave is created.
Leave request approved - webhook will be triggered instantly, as soon as the last approver in the approval flow approves the leave request and the status changes to Approved.
Leave request rejected - webhook will be triggered instantly, as soon as at least one approver in the approval flow rejects the leave request and the status changes to Rejected.
Leave request withdrawn - webhook will be triggered instantly, as soon as the leave request is withdrawn and the status changes to Withdrawn.
Applicants:
Applicant created - webhook will be triggered instantly, as soon as the user has created a new applicant.
Applicant offer accepted - webhook will be triggered instantly, as soon as the applicant accepts and signs an offer.
Vacancy:
Vacancy created - webhook will be triggered instantly, as soon as a vacancy is created.
Vacancy application created - triggers instantly whenever a candidate applies or is added to a vacancy.
Other:
Survey launched - triggered instantly as soon as survey moves from "Scheduled" to "Running".