Skip to main content
Deputy
Deputy
49 actions · 47 events · 1 auth method
PreviewHRIS

​
Authentication

OAuth 2.0

OAuth 2.0 is the recommended authentication method for Deputy.Guides: Connector Profile, Link Account
Actions
49 actions
Action
Description
List Locations
Get all locations (companies) in the Deputy installation
Create Location
Create a new location in Deputy
Update Location
Update an existing location in Deputy
Delete Location
Delete a location in Deputy
Add New Workplace
Add a new workplace/location to Deputy
List Employees
Get details for all employees
Search Employees
Search and filter employees by criteria
Get Employee
Get details for an employee by ID
Create Employee
Add an employee
Update Employee
Update an existing employee
Add Location To Employee
Add a location against an employee
Remove Location From Employee
Remove a location from an employee
Terminate Employee
Terminate an employee
Activate Employee
Re-activate a terminated employee
Invite Employee
Invite employee to Deputy
Get Employee Shift Status
Check whether an employee is currently clocked on, on break, or off shift
Post A Journal
Post a journal entry for an employee
Get Employee Unavailability
Get unavailability details for an employee
Add Employee Unavailability
Add unavailability details for an employee
List Employee Agreements
Get all employee agreements
Search Employment Contracts
Search for employment contracts using query filters
Search Employment Contract Leave Rules
Search for employment contract leave rules
List Employee Roles
Get all employee roles
List Employee Workplaces
Get all employee workplace records
Search Employee History
Search for employee history records
List Employee Availability
Get all employee availability records
List Employee Appraisals
Get all employee appraisal records
List Employee Agreement History
Get all employee agreement history records
List Employment Conditions
Get all employment condition records
Start Timesheet (Clock On)
Start an employee’s timesheet (Clock On)
Stop Timesheet (Clock Off)
Stop an employee’s timesheet (Clock Off)
Pause/Unpause Timesheet
Pause or unpause an employee’s timesheet (take a break/finish break)
View Timesheet Details
View a timesheet by ID
Get Recent Rosters
Get rosters from last 12 hours and forward 36 hours
Copy Rosters
Copy rosters from one date range to another
Publish Rosters
Publish rosters to make them visible to employees
Discard Rosters
Discard unpublished rosters
List Operational Units
Get all operational units (areas/departments)
Create Operational Unit
Create a new operational unit (department/area)
Create Multiple Operational Units
Create multiple operational units (departments/areas) at once
Update Operational Unit
Update an existing operational unit
Delete Operational Unit
Delete an operational unit
List Awards Library
Get awards library list
Get Agreed Hours By Employee ID
Get agreed hours for a specific employee
Create Memo
Create a memo in Deputy
Retrieve Sales Data
Get sales metrics data
List Categories
Get all categories
List Custom Fields
Get all custom field definitions
List Events
Get all events
Events
47 events
Event
Description
Company Insert Webhook
Processes Deputy Company.Insert webhook events.
Company Update Webhook
Processes Deputy Company.Update webhook events.
Company Delete Webhook
Processes Deputy Company.Delete webhook events.
Comment Insert Webhook
Processes Deputy Comment.Insert webhook events.
Comment Update Webhook
Processes Deputy Comment.Update webhook events.
Comment Delete Webhook
Processes Deputy Comment.Delete webhook events.
Employee Insert Webhook
Processes Deputy Employee.Insert webhook events.
Employee Update Webhook
Processes Deputy Employee.Update webhook events.
Employee Delete Webhook
Processes Deputy Employee.Delete webhook events.
EmployeeAvailability Insert Webhook
Processes Deputy EmployeeAvailability.Insert webhook events.
EmployeeAvailability Update Webhook
Processes Deputy EmployeeAvailability.Update webhook events.
EmployeeAvailability Delete Webhook
Processes Deputy EmployeeAvailability.Delete webhook events.
Leave Insert Webhook
Processes Deputy Leave.Insert webhook events.
Leave Update Webhook
Processes Deputy Leave.Update webhook events.
Leave Delete Webhook
Processes Deputy Leave.Delete webhook events.
Memo Insert Webhook
Processes Deputy Memo.Insert webhook events.
Memo Update Webhook
Processes Deputy Memo.Update webhook events.
Memo Delete Webhook
Processes Deputy Memo.Delete webhook events.
OperationalUnit Insert Webhook
Processes Deputy OperationalUnit.Insert webhook events.
OperationalUnit Update Webhook
Processes Deputy OperationalUnit.Update webhook events.
OperationalUnit Delete Webhook
Processes Deputy OperationalUnit.Delete webhook events.
Roster Insert Webhook
Processes Deputy Roster.Insert webhook events.
Roster Update Webhook
Processes Deputy Roster.Update webhook events.
Roster Delete Webhook
Processes Deputy Roster.Delete webhook events.
RosterOpen Insert Webhook
Processes Deputy RosterOpen.Insert webhook events.
RosterOpen Update Webhook
Processes Deputy RosterOpen.Update webhook events.
RosterOpen Delete Webhook
Processes Deputy RosterOpen.Delete webhook events.
RosterSwap Insert Webhook
Processes Deputy RosterSwap.Insert webhook events.
RosterSwap Update Webhook
Processes Deputy RosterSwap.Update webhook events.
RosterSwap Delete Webhook
Processes Deputy RosterSwap.Delete webhook events.
Task Insert Webhook
Processes Deputy Task.Insert webhook events.
Task Update Webhook
Processes Deputy Task.Update webhook events.
Task Delete Webhook
Processes Deputy Task.Delete webhook events.
Timesheet Insert Webhook
Processes Deputy Timesheet.Insert webhook events.
Timesheet Update Webhook
Processes Deputy Timesheet.Update webhook events.
Timesheet Delete Webhook
Processes Deputy Timesheet.Delete webhook events.
TimesheetPayReturn Insert Webhook
Processes Deputy TimesheetPayReturn.Insert webhook events.
TimesheetPayReturn Update Webhook
Processes Deputy TimesheetPayReturn.Update webhook events.
TimesheetPayReturn Delete Webhook
Processes Deputy TimesheetPayReturn.Delete webhook events.
TrainingRecord Insert Webhook
Processes Deputy TrainingRecord.Insert webhook events.
TrainingRecord Update Webhook
Processes Deputy TrainingRecord.Update webhook events.
TrainingRecord Delete Webhook
Processes Deputy TrainingRecord.Delete webhook events.
Roster Publish Webhook
Processes Deputy Roster.Publish webhook events.
User Login Webhook
Processes Deputy User.Login webhook events.
TimesheetExport Begin Webhook
Processes Deputy TimesheetExport.Begin webhook events.
TimesheetExport End Webhook
Processes Deputy TimesheetExport.End webhook events.
Device Registration Webhook
Processes Deputy Device.Registration webhook events.

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.

Connector Profile

Deputy - OAuth 2.0
3

Link an Account

Connect an account using StackOne Hub or Auth Link.

Link Account

Deputy - OAuth 2.0
4

Use Actions

Invoke actions using one of the methods below:

​
Webhook Events

Webhooks setup

Configure receiving Events for Deputy into StackOne.