Webhooks overview

Webhooks let you subscribe to events happening in PeopleForce. Rather than polling the API, you configure an endpoint and PeopleForce sends it an HTTP POST request whenever a subscribed event fires. You manage subscriptions — and review past deliveries and their payloads — in your PeopleForce Settings.

See Starting with webhooks for how to create one, secure it with a signing secret, and test deliveries.

Every delivery has the shape { "action": "<topic>", "data": { … } }, where action is the topic name (e.g. employee_create).

Doesn't your integration support receiving webhooks? Check whether it supports Zapier — PeopleForce offers a range of triggers and actions for Zapier.

Available topics

PeopleForce offers the webhook topics below. Availability depends on the PeopleForce modules enabled for your account.

Employee

Topic	Description
`employee_create`	An employee is created.
`employee_update`	An employee is updated.
`employee_start`	An employee's first day (hire date is reached).
`employee_terminate`	An employee is terminated.
`employee_termination_revert`	An employee's termination is reverted (reactivation).
`employee_position_create`	An employee position record is created.
`employee_position_update`	An employee position record is updated.
`employee_salary_create`	An employee salary record is created.
`employee_salary_update`	An employee salary record is updated.
`employee_additional_compensation_create`	An additional compensation is created.
`employee_additional_compensation_update`	An additional compensation is updated.
`employee_employment_status_create`	An employment status record is created.
`employee_employment_status_update`	An employment status record is updated.
`external_user_create`	An external user is created.

Leave

Topic	Description
`leave_request_create`	A leave request is created.
`leave_request_approve`	A leave request is approved.
`leave_request_reject`	A leave request is rejected.
`leave_request_withdraw`	A leave request is withdrawn.
`leave_request_destroy`	A leave request is deleted.

Recruitment

Topic	Description
`applicant_create`	A candidate is created.
`applicant_destroy`	A candidate is deleted.
`vacancy_create`	A vacancy is created.
`vacancy_application_create`	A candidate applied or was added to a vacancy.
`vacancy_application_movement`	An application moved pipeline stage, was disqualified, or requalified.
`vacancy_offer_accept`	A vacancy offer was accepted by the candidate.
`vacancy_offer_reject`	A vacancy offer was rejected by the candidate.

Time

Topic	Description
`overtime_request_create`	An overtime request is created.
`overtime_request_update`	An overtime request is updated.
`overtime_request_destroy`	An overtime request is deleted.
`overtime_request_approve`	An overtime request is approved.

Other

Topic	Description
`survey_start`	A survey is launched (moves from Scheduled to Running).

A workflow webhook can also be configured as an action inside a workflow — it isn't part of the subscribable topic list above. See Other webhooks.

Delivery headers

Every delivery includes:

Content-Type: application/json
X-PeopleForce-Endpoint — the webhook endpoint ID
X-PeopleForce-Delivery — a unique delivery ID
X-PeopleForce-Signature — present only when the endpoint has a secret configured (see signing)

Deliveries time out after 5 seconds and require a valid TLS certificate.

The pages in this section group these topics and show example payloads: Employee profile, Employee position, Employee compensation, Leave requests, Candidates and vacancies, and Other webhooks.