> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Deputy

> How to set up the Deputy connector, plus the actions and events that are available.

![Deputy](https://stackone-logos.com/api/deputy/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/deputy/changelog.md)

[49 actions](#actions) · [47 events](#events) · 2 auth methods

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/deputy/guides/connector-profile/api-key.md)
>
> Uses a permanent access token generated from an OAuth client in your own Deputy install, and only grants access to that...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/deputy/guides/connector-profile/oauth-2-0.md)
>
> OAuth 2.0 is the recommended authentication method for Deputy.

Optionally, configure receiving Events for Deputy into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/deputy/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/deputy/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/deputy/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

49 actions

ActionDescription

List Locations`deputy_list_locations`

Get all locations (companies) in the Deputy installation

Create Location`deputy_create_location`

Create a new location in Deputy

Update Location`deputy_update_location`

Update an existing location in Deputy

Delete Location`deputy_delete_location`

Delete a location in Deputy

Add New Workplace`deputy_add_new_workplace`

Add a new workplace/location to Deputy

List Employees`deputy_list_employees`

Get details for all employees

Search Employees`deputy_search_employees`

Search and filter employees by criteria

Get Employee`deputy_get_employee`

Get details for an employee by ID

Create Employee`deputy_create_employee`

Add an employee

Update Employee`deputy_update_employee`

Update an existing employee

Add Location To Employee`deputy_add_employee_location`

Add a location against an employee

Remove Location From Employee`deputy_remove_employee_location`

Remove a location from an employee

Terminate Employee`deputy_terminate_employee`

Terminate an employee

Activate Employee`deputy_activate_employee`

Re-activate a terminated employee

Invite Employee`deputy_invite_employee`

Invite employee to Deputy

Get Employee Shift Status`deputy_get_employee_shift_status`

Check whether an employee is currently clocked on, on break, or off shift

Post A Journal`deputy_create_journal`

Post a journal entry for an employee

Get Employee Unavailability`deputy_get_employee_unavailability`

Get unavailability details for an employee

Add Employee Unavailability`deputy_create_employee_unavailability`

Add unavailability details for an employee

List Employee Agreements`deputy_list_employee_agreements`

Get all employee agreements

Search Employment Contracts`deputy_search_employment_contracts`

Search for employment contracts using query filters

Search Employment Contract Leave Rules`deputy_search_employment_contract_leave_rules`

Search for employment contract leave rules

List Employee Roles`deputy_list_employee_roles`

Get all employee roles

List Employee Workplaces`deputy_list_employee_workplaces`

Get all employee workplace records

Search Employee History`deputy_search_employee_history`

Search for employee history records

List Employee Availability`deputy_list_employee_availability`

Get all employee availability records

List Employee Appraisals`deputy_list_employee_appraisals`

Get all employee appraisal records

List Employee Agreement History`deputy_list_employee_agreement_history`

Get all employee agreement history records

List Employment Conditions`deputy_list_employment_conditions`

Get all employment condition records

Start Timesheet (Clock On)`deputy_start_timesheet`

Start an employee's timesheet (Clock On)

Stop Timesheet (Clock Off)`deputy_stop_timesheet`

Stop an employee's timesheet (Clock Off)

Pause/Unpause Timesheet`deputy_pause_timesheet`

Pause or unpause an employee's timesheet (take a break/finish break)

View Timesheet Details`deputy_get_timesheet_details`

View a timesheet by ID

Get Recent Rosters`deputy_get_recent_rosters`

Get rosters from last 12 hours and forward 36 hours

Copy Rosters`deputy_copy_rosters`

Copy rosters from one date range to another

Publish Rosters`deputy_publish_rosters`

Publish rosters to make them visible to employees

Discard Rosters`deputy_discard_rosters`

Discard unpublished rosters

List Operational Units`deputy_list_operational_units`

Get all operational units (areas/departments)

Create Operational Unit`deputy_create_operational_unit`

Create a new operational unit (department/area)

Create Multiple Operational Units`deputy_create_multiple_operational_units`

Create multiple operational units (departments/areas) at once

Update Operational Unit`deputy_update_operational_unit`

Update an existing operational unit

Delete Operational Unit`deputy_delete_operational_unit`

Delete an operational unit

List Awards Library`deputy_list_awards_library`

Get awards library list

Get Agreed Hours By Employee ID`deputy_get_agreed_hours_by_employee`

Get agreed hours for a specific employee

Create Memo`deputy_create_memo`

Create a memo in Deputy

Retrieve Sales Data`deputy_get_sales_data`

Get sales metrics data

List Categories`deputy_list_categories`

Get all categories

List Custom Fields`deputy_list_custom_fields`

Get all custom field definitions

List Events`deputy_list_events`

Get all events

## Events

Tags

Select all
|
Clear

Availability

Comments

Devices

Employees

Leaves

Locations

Memos

Operational Units

Rosters

Tasks

Timesheets

Training Records

Users

Webhooks

No tags found

47 events

EventDescriptionTags

Company Insert Webhook`deputy_webhook_company_insert`

Processes Deputy Company.Insert webhook events.

LocationsWebhooks

Company Update Webhook`deputy_webhook_company_update`

Processes Deputy Company.Update webhook events.

LocationsWebhooks

Company Delete Webhook`deputy_webhook_company_delete`

Processes Deputy Company.Delete webhook events.

LocationsWebhooks

Comment Insert Webhook`deputy_webhook_comment_insert`

Processes Deputy Comment.Insert webhook events.

CommentsWebhooks

Comment Update Webhook`deputy_webhook_comment_update`

Processes Deputy Comment.Update webhook events.

CommentsWebhooks

Comment Delete Webhook`deputy_webhook_comment_delete`

Processes Deputy Comment.Delete webhook events.

CommentsWebhooks

Employee Insert Webhook`deputy_webhook_employee_insert`

Processes Deputy Employee.Insert webhook events.

EmployeesWebhooks

Employee Update Webhook`deputy_webhook_employee_update`

Processes Deputy Employee.Update webhook events.

EmployeesWebhooks

Employee Delete Webhook`deputy_webhook_employee_delete`

Processes Deputy Employee.Delete webhook events.

EmployeesWebhooks

EmployeeAvailability Insert Webhook`deputy_webhook_employee_availability_insert`

Processes Deputy EmployeeAvailability.Insert webhook events.

EmployeesAvailabilityWebhooks

EmployeeAvailability Update Webhook`deputy_webhook_employee_availability_update`

Processes Deputy EmployeeAvailability.Update webhook events.

EmployeesAvailabilityWebhooks

EmployeeAvailability Delete Webhook`deputy_webhook_employee_availability_delete`

Processes Deputy EmployeeAvailability.Delete webhook events.

EmployeesAvailabilityWebhooks

Leave Insert Webhook`deputy_webhook_leave_insert`

Processes Deputy Leave.Insert webhook events.

LeavesWebhooks

Leave Update Webhook`deputy_webhook_leave_update`

Processes Deputy Leave.Update webhook events.

LeavesWebhooks

Leave Delete Webhook`deputy_webhook_leave_delete`

Processes Deputy Leave.Delete webhook events.

LeavesWebhooks

Memo Insert Webhook`deputy_webhook_memo_insert`

Processes Deputy Memo.Insert webhook events.

MemosWebhooks

Memo Update Webhook`deputy_webhook_memo_update`

Processes Deputy Memo.Update webhook events.

MemosWebhooks

Memo Delete Webhook`deputy_webhook_memo_delete`

Processes Deputy Memo.Delete webhook events.

MemosWebhooks

OperationalUnit Insert Webhook`deputy_webhook_operational_unit_insert`

Processes Deputy OperationalUnit.Insert webhook events.

Operational UnitsWebhooks

OperationalUnit Update Webhook`deputy_webhook_operational_unit_update`

Processes Deputy OperationalUnit.Update webhook events.

Operational UnitsWebhooks

OperationalUnit Delete Webhook`deputy_webhook_operational_unit_delete`

Processes Deputy OperationalUnit.Delete webhook events.

Operational UnitsWebhooks

Roster Insert Webhook`deputy_webhook_roster_insert`

Processes Deputy Roster.Insert webhook events.

RostersWebhooks

Roster Update Webhook`deputy_webhook_roster_update`

Processes Deputy Roster.Update webhook events.

RostersWebhooks

Roster Delete Webhook`deputy_webhook_roster_delete`

Processes Deputy Roster.Delete webhook events.

RostersWebhooks

RosterOpen Insert Webhook`deputy_webhook_roster_open_insert`

Processes Deputy RosterOpen.Insert webhook events.

RostersWebhooks

RosterOpen Update Webhook`deputy_webhook_roster_open_update`

Processes Deputy RosterOpen.Update webhook events.

RostersWebhooks

RosterOpen Delete Webhook`deputy_webhook_roster_open_delete`

Processes Deputy RosterOpen.Delete webhook events.

RostersWebhooks

RosterSwap Insert Webhook`deputy_webhook_roster_swap_insert`

Processes Deputy RosterSwap.Insert webhook events.

RostersWebhooks

RosterSwap Update Webhook`deputy_webhook_roster_swap_update`

Processes Deputy RosterSwap.Update webhook events.

RostersWebhooks

RosterSwap Delete Webhook`deputy_webhook_roster_swap_delete`

Processes Deputy RosterSwap.Delete webhook events.

RostersWebhooks

Task Insert Webhook`deputy_webhook_task_insert`

Processes Deputy Task.Insert webhook events.

TasksWebhooks

Task Update Webhook`deputy_webhook_task_update`

Processes Deputy Task.Update webhook events.

TasksWebhooks

Task Delete Webhook`deputy_webhook_task_delete`

Processes Deputy Task.Delete webhook events.

TasksWebhooks

Timesheet Insert Webhook`deputy_webhook_timesheet_insert`

Processes Deputy Timesheet.Insert webhook events.

TimesheetsWebhooks

Timesheet Update Webhook`deputy_webhook_timesheet_update`

Processes Deputy Timesheet.Update webhook events.

TimesheetsWebhooks

Timesheet Delete Webhook`deputy_webhook_timesheet_delete`

Processes Deputy Timesheet.Delete webhook events.

TimesheetsWebhooks

TimesheetPayReturn Insert Webhook`deputy_webhook_timesheet_pay_return_insert`

Processes Deputy TimesheetPayReturn.Insert webhook events.

TimesheetsWebhooks

TimesheetPayReturn Update Webhook`deputy_webhook_timesheet_pay_return_update`

Processes Deputy TimesheetPayReturn.Update webhook events.

TimesheetsWebhooks

TimesheetPayReturn Delete Webhook`deputy_webhook_timesheet_pay_return_delete`

Processes Deputy TimesheetPayReturn.Delete webhook events.

TimesheetsWebhooks

TrainingRecord Insert Webhook`deputy_webhook_training_record_insert`

Processes Deputy TrainingRecord.Insert webhook events.

Training RecordsWebhooks

TrainingRecord Update Webhook`deputy_webhook_training_record_update`

Processes Deputy TrainingRecord.Update webhook events.

Training RecordsWebhooks

TrainingRecord Delete Webhook`deputy_webhook_training_record_delete`

Processes Deputy TrainingRecord.Delete webhook events.

Training RecordsWebhooks

Roster Publish Webhook`deputy_webhook_roster_publish`

Processes Deputy Roster.Publish webhook events.

RostersWebhooks

User Login Webhook`deputy_webhook_user_login`

Processes Deputy User.Login webhook events.

UsersWebhooks

TimesheetExport Begin Webhook`deputy_webhook_timesheet_export_begin`

Processes Deputy TimesheetExport.Begin webhook events.

TimesheetsWebhooks

TimesheetExport End Webhook`deputy_webhook_timesheet_export_end`

Processes Deputy TimesheetExport.End webhook events.

TimesheetsWebhooks

Device Registration Webhook`deputy_webhook_device_registration`

Processes Deputy Device.Registration webhook events.

DevicesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.