HomeGuidesAPI ReferenceChangelogDiscussions
API Reference
These docs are for v1.0. Click to read the latest docs for v2024-10-01.

Create a webhook subscription

Creates a subscription for a determined webhook type. If webhook already exists, it just changes the target_url.

Webhooks Types

Subscription TypeInformation
Authentication::Events::AccessInvitedWhen creating a new employee, optionally you can send an invitation to create an account in Factorial. If you send an invitation, this event gets triggered.
Employees::Events::EmployeeCreatedWhen creating a new employee, after submitting the form, this event gets triggered.
Employees::Events::EmployeeUpdatedWhen updating personal protected employee information such has birthday, this event gets triggered.
Employees::Events::EmployeeTerminatedWhen terminating an employee, after submitting the form, this event gets triggered
Employees::Events::EmployeeUnterminatedWhen un terminating an employee, after submitting the form, this event gets triggered
Attendance::Events::ClockInWhen the user clocks in and starts the timer, this event is triggered.
Attendance::Events::ClockOutWhen the user clocks out and stops the timer, this event is triggered
Attendance::Events::AttendanceShiftCreatedWhen the user creates a shift, this event is triggered
Attendance::Events::AttendanceShiftUpdatedWhen the user edits a shift, this event is triggered
Attendance::Events::AttendanceShiftDeletedWhen the user deletes a shift, this event is triggered
Ats::Events::ApplicationCreatedWhen a candidate applies for a posting.
Ats::Events::ApplicationUpdatedWhen a candidates application for a posting suffers changes.
Ats::Events::JobPostingCreatedWhen a job posting is created.
Ats::Events::JobPostingUpdatedWhen a job posting is updated.
Ats::Events::JobPostingDeletedWhen a job posting is deleted.
Timeoff::Events::LeaveCreatedWhen a Timeoff Leave is created.
Timeoff::Events::LeaveDestroyedWhen a Timeoff Leave is destroyed.
Timeoff::Events::LeaveUpdatedWhen a Timeoff Leave suffers any changes.
Timeoff::Events::LeaveApprovedWhen a Timeoff Leave is explicitly approved.
Timeoff::Events::LeaveRejectedWhen a Timeoff Leave is rejected.
Documents::Events::CreatedWhen a document is created.
Tasks::Events::CreatedWhen a task is created.
Contracts::Events::ContractVersionCreatedWhen a contract version is created.
Contracts::Events::ContractVersionUpdatedWhen a contract version is updated.
Payroll::Events::SupplementCreatedWhen a payroll supplement is created.
Payroll::Events::SupplementUpdatedWhen a payroll supplement is updated.
Payroll::Events::SupplementDeletedWhen a payroll supplement is deleted.
Payroll::Events::PolicyPeriodStatusUpdatedWhen a payroll policy period's status is updated. Statuses include preparation, supplements_definition, under_review, payroll_calculation, and paid
BookkeepersManagement::Events::IncidenceStatusCreatedWhen an employee update is validated.
Language
Credentials
URL
Click Try It! to start a request and see the response here!