Jump to Content

Guides API Reference Changelog Discussions

Back to 7shifts.com Become a Partner

API Reference

Back to 7shifts.com Become a Partner

Guides API Reference Changelog Discussions

All

Pages

Start typing to search…

API Usage

Introduction
Authentication
Errors
Versioning
Pagination
API Status & Support
Postman Collection

7shifts API

Authentication
- Create OAuth Tokenpost
- Retrieve Identityget
Account
- Create Trial Accountpost
Companies
Locations
Departments
Roles
Users
User Wages
- List User Wagesget
- Create User Wagepost
User Assignments
Employment Record
Shifts
Schedule Enforcement
- List Scheduled Shiftsget
Time Punches
Receipts
External User Mappings
Schedule Events
Log Book
Task Management
Reports
Forecast Overrides
Tip Pool
Day Part
- Retrieve day part settingsget
Availability
Time Off
Shift Feedback
- List Shift Feedbackget
Engage
- Retrieve Engagement Overviewget
Webhooks
Integration Mappings

Webhooks

Introduction
Configure Company Level Webhooks
payroll_period.closed
schedule.published
time_punch.created
time_punch.edited
time_punch.deleted
user.created
user.modified
user.deactivated
user.reactivated
department.created
department.modified
department.deleted
location.created
location.modified
location.deleted
role.created
role.modified
role.deleted
authorization.revoked

Test Webhook

get https://api.7shifts.com/v2/company/{company_id}/test_webhook

Minimum Plan Required: Gourmet

Language

Credentials

Bearer

Click Try It! to start a request and see the response here!