Deputy
Bring new starters, changes and leavers from Deputy into every system that needs them, with HR approving each change.
22 ways to read, 9 ways to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with Deputy, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Create area
areas.createApproval by rule - Add unavailability
availability.createApproval by rule - List areas
areas.listRead
Example flow
- Deputy · List areas
areas.listDone - Deputy · Create area
areas.createMaker-checker - Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches Deputy.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to Deputy
- Deputy's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect your own account when you are ready to go live.
For developers
Technical detail
Read Deputy employees, locations, areas, shifts, timesheets, leave, availability, training and memos; create and update shifts, areas and leave; add employees, unavailability and journals.
Deputy Group Pty Ltd API docs- Source actions
- 22
- Destination actions
- 9
- Data types
- 12
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
areas4
- Create areaDestinationNot retried automaticallyApproval before production
Creates an area (operational unit) in a location.
- Get areaSource
One area by ID.
- List areasSource
Areas (operational units) within locations.
- Update areaDestinationProvider duplicate protectionApproval before production
Renames, moves or deactivates an area.
availability3
- Add unavailabilityDestinationNot retried automaticallyApproval before production
Records a one-off or recurring period when an employee cannot work.
- Get availabilitySource
One availability by ID.
- List availabilitySourceIncremental
Employee availability and unavailability records.
employees3
- Create employeeDestinationNot retried automaticallyApproval before production
Adds an employee to a location (Management API v2).
- Get employeeSource
One employee by ID.
- List employeesSourceIncremental
Employees with main location, role and employment dates.
journals3
- Create journal noteDestinationNot retried automaticallyApproval before production
Adds a journal note to an employee.
- Get journalSource
One journal by ID.
- List journalsSourceIncremental
Manager journal notes about employees.
leave rules1
- List leave rulesSource
Leave types (rules) such as annual or sick leave.
leave4
- Create leaveDestinationNot retried automaticallyApproval before production
Creates a leave request for an employee, awaiting approval by default.
- Get leaveSource
One leave by ID.
- List leaveSourceIncremental
Leave requests with dates, hours, leave rule and status.
- Update leaveDestinationProvider duplicate protectionApproval before production
Changes the dates, leave rule or comment of a leave request (not its approval).
locations2
- Get locationSource
One location by ID.
- List locationsSource
Locations (Deputy Company records) with address and active flag.
memos2
- Get memoSource
One memo by ID.
- List memosSourceIncremental
Newsfeed memos posted to staff (read only; Nexra never posts memos).
rosters4
- Create shiftDestinationNot retried automaticallyApproval before production
Creates an unpublished shift in an area, assigned or open.
- Get shiftSource
One rostered shift by ID.
- List shiftsSourceIncremental
Rostered shifts with employee, area, times, cost and publish state.
- Update shiftDestinationProvider duplicate protectionApproval before production
Changes a shift's times, area, employee or comment.
timesheets2
- Get timesheetSource
One timesheet by ID.
- List timesheetsSourceIncremental
Worked time with start, end, hours, cost and approval (read only).
training modules1
- List training modulesSource
Training types that can be assigned to employees (read only).
training records2
- Get training recordSource
One training record by ID.
- List training recordsSourceIncremental
Training completed by employees, with validity and expiry (read only).
Access and limits
- Authentication
- Deputy permanent access token
- Plans and access
- Deputy Premium or Enterprise installs with API access. A permanent token acts as the system administrator who created it and works only for that install.
- Test environment
- Use a Deputy free trial install for testing.
- Rate limits
- Deputy does not publish rate limits; Nexra backs off on HTTP 429 and honours Retry-After.
- Pagination
- Resource QUERY with start and max (up to 500 records), sorted by Id.
- Provider events
- Deputy webhooks for resource insert, update and delete events. Flows run on demand, on a schedule, or when a scheduled check finds new or changed records.
Before you build a flow
- Shifts are created and updated through the Roster resource and are left unpublished; publishing (which notifies employees) is not automated.
- Timesheets are read only. Clocking employees on or off is not implemented because it changes live attendance.
- Employees are created with the Management v2 API; updating employees is not implemented because the resource update requires the full record.
- Leave is created as awaiting approval (Status 0) unless another status is mapped.
- Memos are read only: creating a memo posts it to staff newsfeeds, so it is never sent from Nexra. Roster publishing, timesheet approval, clock on/off, employee termination and invites are intentionally excluded.
- Leave updates change dates and comments only; approving or declining leave (Status) is not automated.
- Unavailability is added through the documented supervise/unavail endpoint and is not idempotent; availability records are read with the EmployeeAvailability resource.
- Training modules and records are read only.
- Dates of birth, gender and pay rates are not mapped. Deletes are not implemented; Deputy has no idempotency key.
Developer reference
- Create the Deputy Group Pty Ltd credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose Deputy, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/deputy and the Connections API.