Overview

This step-by-step guide will walk you through creating an employee sync integration with 7shifts through the 7shifts REST API.

📘

MAPPING NOTE

This section requires an understanding of how to map locations, departments, and roles.

Upon completion of this guide, you will have created an integration that can interact with the 7shifts platform as follows:

• Establish entity mapping between your system & 7shifts.
• Create employee data & assignments in 7shifts.
• Update existing employee data & assignments in 7shifts.
• Update assignment data for existing employees in 7shifts.
• Read employee data & wage assignments from 7shifts.
• Manage employment records in 7shifts.

What’s in it for the client?

• Ability to create new employees in your system and having them show up in 7shifts with proper role & wage data
• Ability to update existing 7shifts employee data to reflect changes from your system
• Ability to read employee & wage data from 7shifts

Requirements

• An API key, OAuth Cllient or Access Token for a test/sandbox 7shifts account.
• cURL or Postman to make test requests.

Restrictions

• You may only make 10 requests per second per token across all API endpoints.
• 7shifts generally anticipates that only Employee profiles are being synced through this integration. Syncing Manager or Assistant Manager profiles is possible but will be reviewed per implementation to ensure minimal risk of impacting 7shifts' user permissions for these roles.

Functionality Overview

The employee sync integration ensures that employee data remains consistent between your system and 7shifts. This involves creating or updating employee data in 7shifts when there’s an update to employee data in your system.

You will be interacting with the following 7shifts API endpoints for building this integration:

• POST Location
• POST Department
• POST Role
• POST User
• POST User Wages
• GET Company

Functionality Limitations

This integration guide doesn’t cover every employee sync possibility. Here are some of the limitations you should note:

• Only the following information should be synced through this integration:

  • First name
  • Last name
  • Email (must not be updated after create. Doing so may prevent a user from signing in if they are not aware of the change)
  • Phone
  • Active/Inactive state
  • Role Assignment
  • Department Assignment
  • Location Assignment
  • Wage Assignment
  • Employment Records

• Generally, 7shifts anticipates that only profiles with the 7shifts user type 'Employee' will be created. Creating Manager & Assistant Manager profiles through an integration can result in unanticipated permission-related impacts for 7shifts customers. Admin users cannot be created through the 7shifts API; elevating any existing user to an Admin or other higher role can be done through 7shifts web app.