Deputy Webhook Setup Guide

Events related to employee records.

• Employee Created (Employee.Insert) — Fired when a new employee is added
• Employee Updated (Employee.Update) — Fired when an employee record changes
• Employee Deleted (Employee.Delete) — Fired when an employee is removed

Events for the days and hours employees set as available or unavailable to work.

• Availability Created (EmployeeAvailability.Insert) — Fired when an employee adds an availability entry
• Availability Updated (EmployeeAvailability.Update) — Fired when an availability entry changes
• Availability Deleted (EmployeeAvailability.Delete) — Fired when an availability entry is removed

Events on company/location (business) records.

• Location Created (Company.Insert) — Fired when a new location is added
• Location Updated (Company.Update) — Fired when a location’s details change
• Location Deleted (Company.Delete) — Fired when a location is deleted

Events on Areas (called Operational Units in the API) — the jobs or places within a location, such as Chef or Front of House.

• Area Created (OperationalUnit.Insert) — Fired when a new area is created
• Area Updated (OperationalUnit.Update) — Fired when an area’s details change
• Area Deleted (OperationalUnit.Delete) — Fired when an area is deleted

Events on Schedules (called Rosters in the API) — shifts assigned to employees.

• Shift Created (Roster.Insert) — Fired when a shift is added to a schedule
• Shift Updated (Roster.Update) — Fired when a shift’s details change
• Shift Deleted (Roster.Delete) — Fired when a shift is removed
• Schedule Published (Roster.Publish) — Fired when a schedule is published to staff

Events on shifts that are open (not yet assigned to an employee).

• Open Shift Created (RosterOpen.Insert) — Fired when an unassigned open shift is created
• Open Shift Updated (RosterOpen.Update) — Fired when an open shift changes
• Open Shift Deleted (RosterOpen.Delete) — Fired when an open shift is removed

Events on shifts offered for swap between employees.

• Swap Created (RosterSwap.Insert) — Fired when a shift is offered for swap
• Swap Updated (RosterSwap.Update) — Fired when a shift swap changes
• Swap Deleted (RosterSwap.Delete) — Fired when a shift swap is withdrawn

Events on timesheets, created as employees clock in and out.

• Timesheet Created (Timesheet.Insert) — Fired when a timesheet is created (for example, an employee clocks in)
• Timesheet Updated (Timesheet.Update) — Fired when a timesheet changes (for example, clock-out or an edit)
• Timesheet Deleted (Timesheet.Delete) — Fired when a timesheet is deleted

Events on the pay-approval status of a timesheet.

• Pay Approval Created (TimesheetPayReturn.Insert) — Fired when a timesheet’s pay approval is recorded
• Pay Approval Updated (TimesheetPayReturn.Update) — Fired when a timesheet’s pay-approval status changes
• Pay Approval Deleted (TimesheetPayReturn.Delete) — Fired when a pay-approval record is removed

Events on timesheet exports to a third-party or payroll system.

• Export Started (TimesheetExport.Begin) — Fired when a timesheet export begins
• Export Finished (TimesheetExport.End) — Fired when a timesheet export completes

Events on employee leave records, such as annual leave.

• Leave Created (Leave.Insert) — Fired when a leave request is created
• Leave Updated (Leave.Update) — Fired when a leave request changes (for example, it is approved)
• Leave Deleted (Leave.Delete) — Fired when a leave request is removed

Events on tasks assigned to employees.

• Task Created (Task.Insert) — Fired when a task is created
• Task Updated (Task.Update) — Fired when a task changes
• Task Deleted (Task.Delete) — Fired when a task is deleted

Events on posts in the Deputy news feed (called Memos in the API).

• Post Created (Memo.Insert) — Fired when a news feed post is created
• Post Updated (Memo.Update) — Fired when a news feed post is edited
• Post Deleted (Memo.Delete) — Fired when a news feed post is deleted

Events on comments made against items such as the news feed.

• Comment Created (Comment.Insert) — Fired when a comment is added
• Comment Updated (Comment.Update) — Fired when a comment is edited
• Comment Deleted (Comment.Delete) — Fired when a comment is deleted

Events on training assigned to employees.

• Training Record Created (TrainingRecord.Insert) — Fired when training is assigned to an employee
• Training Record Updated (TrainingRecord.Update) — Fired when a training record changes
• Training Record Deleted (TrainingRecord.Delete) — Fired when a training record is removed

Account-level activity events.

• User Login (User.Login) — Fired when a user logs in to Deputy
• Device Registration (Device.Registration) — Fired when a new device (kiosk tablet or mobile app) connects to the installation

Deputy delivers each event as its own HTTP POST with a JSON body of the form { "topic": "<Resource>.<Action>", "data": { ... } } — topic is the event name (for example Employee.Insert) and data is the affected record (its Id is used as the event ID). Deputy sends one event per request; deliveries are not batched.

Each delivery includes X-Deputy-Webhook-Callback (the webhook’s resource URL) and X-Deputy-Generation-Time (a Unix timestamp). On Enterprise installations Deputy also adds X-Deputy-Secret, an HMAC-SHA256 signature of the payload.

Deputy queues webhook deliveries, so an event can arrive seconds to minutes after the change. StackOne responds with 200 OK automatically.