Skip to main content

7shifts Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a 7shifts location.
seven_shifts_api.png

7shifts

Create a 7shifts Destination​

  1. Click the + icon on the Nexset that will be sent to the 7shifts destination, and select the Send to Destination option from the menu.

  2. Select the 7shifts connector from the list of available destination connectors. Then, select the credential that will be used to connect to the 7shifts organization, and click Next; or, create a new 7shifts credential for use in this flow.

  3. In Nexla, 7shifts destinations can be created using pre-built endpoint templates, which expedite destination setup for common 7shifts write operations. Each template is designed specifically for the corresponding 7shifts endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    7shifts destinations can also be configured manually, allowing you to send data to 7shifts endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common 7shifts write endpoints. Each template is designed specifically for the corresponding 7shifts endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Shift

Creates a new shift for a specific location and user. Use this endpoint to programmatically create shift records in 7shifts from external scheduling systems, HR platforms, or data transformation flows. This is the primary write operation for shift scheduling.

  • This endpoint requires no additional parameters beyond the Company ID stored in your credential. Nexla will POST the Nexset data as a JSON body to the 7shifts Shifts API.

  • The data being sent must conform to the 7shifts shift creation schema. Key fields include:

    • location_id: The numeric ID of the location where the shift will take place (required).
    • user_id: The numeric ID of the employee assigned to the shift.
    • department_id: The numeric ID of the department for this shift.
    • role_id: The numeric ID of the role for this shift.
    • start: The shift start time in ISO 8601 format (e.g., 2024-06-01T09:00:00).
    • end: The shift end time in ISO 8601 format.

For the complete list of required and optional fields for creating a shift, refer to the 7shifts Create Shift API reference.

Update Shift

Updates an existing shift identified by its ID. Use this endpoint to modify shift details such as start/end times, assigned employee, location, or role. This is useful for syncing schedule changes from external systems into 7shifts.

  • Enter the numeric ID of the shift to update in the Shift ID field. This parameter is required.

    • Shift IDs can be obtained from the List Shifts or Get Shift source endpoints.
    • The Shift ID is appended to the API URL as a path parameter to identify the specific shift record to update.
  • Nexla will send the Nexset data as a JSON body using a PUT request, which replaces the full shift record with the provided data.

For the complete list of updatable shift fields, refer to the 7shifts Update Shift API reference.

Create Department

Creates a new department within your company. Use this endpoint to programmatically set up department structures in 7shifts when onboarding new locations or reorganizing your organizational hierarchy.

  • This endpoint requires no additional parameters beyond the Company ID stored in your credential. Nexla will POST the Nexset data as a JSON body to the 7shifts Departments API.

  • Key fields for creating a department include:

    • location_id: The numeric ID of the location this department belongs to (required).
    • name: The display name of the department (required).

For a complete list of department creation fields, refer to the 7shifts Create Department API reference.

Update Department

Updates an existing department identified by its ID. Use this endpoint to modify department names or settings when organizational structure changes occur.

  • Enter the numeric ID of the department to update in the Department ID field. This parameter is required.

    • Department IDs can be obtained from the List Departments source endpoint.
  • Nexla will send the Nexset data as a JSON body using a PUT request.

For a complete list of updatable department fields, refer to the 7shifts API documentation for departments.

Create Role

Creates a new role within your company. Roles represent job positions such as Server, Bartender, or Cook. Use this endpoint to programmatically create role definitions when setting up new locations or job classifications.

  • This endpoint requires no additional parameters beyond the Company ID stored in your credential. Nexla will POST the Nexset data as a JSON body to the 7shifts Roles API.

  • Key fields for creating a role include:

    • department_id: The numeric ID of the department this role belongs to (required).
    • name: The display name of the role (required).

For a complete list of role creation fields, refer to the 7shifts Create Role API reference.

Update Role

Updates an existing role identified by its ID. Use this endpoint to modify role names, pay settings, or department associations when job classification changes occur.

  • Enter the numeric ID of the role to update in the Role ID field. This parameter is required.

    • Role IDs can be obtained from the List Roles source endpoint or the Retrieve Role Details source endpoint.
  • Nexla will send the Nexset data as a JSON body using a PUT request.

For a complete list of updatable role fields, refer to the 7shifts Update Role API reference.

Create User

Creates a new user (employee) within your company. Use this endpoint to onboard new employees into 7shifts programmatically from an HR system, payroll platform, or employee management tool.

  • This endpoint requires no additional parameters beyond the Company ID stored in your credential. Nexla will POST the Nexset data as a JSON body to the 7shifts Users API.

  • Key fields for creating a user include:

    • firstname: The employee's first name (required).
    • lastname: The employee's last name (required).
    • email: The employee's email address.
    • mobile_phone: The employee's mobile phone number.
    • employee_id: An external employee identifier for integration with payroll or HR systems.

For the complete list of user creation fields, including required fields and accepted values, refer to the 7shifts Create User API reference.

Update User

Updates an existing user identified by their ID. Use this endpoint to synchronize employee profile changes from HR systems into 7shifts, such as name changes, contact information updates, or employment status changes.

  • Enter the numeric ID of the user to update in the User ID field. This parameter is required.

    • User IDs can be obtained from the List Users or Get User source endpoints.
  • Nexla will send the Nexset data as a JSON body using a PUT request, replacing the full user record with the provided data.

For the complete list of updatable user fields, refer to the 7shifts Users API documentation. Ensure that required fields are included in the payload when performing a full PUT update.

Update Location

Updates an existing location identified by its ID. Use this endpoint to modify location details such as name, address, time zone, or operational settings when business information changes.

  • Enter the numeric ID of the location to update in the Location ID field. This parameter is required.

    • Location IDs can be obtained from the List Locations source endpoint.
  • Nexla will send the Nexset data as a JSON body using a PUT request.

For the complete list of updatable location fields, refer to the 7shifts Update Location API reference.

Configure Manually​

7shifts destinations can be manually configured to send data to any valid 7shifts API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the 7shifts API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the 7shifts API from the Method pulldown menu. For write operations in 7shifts, the most commonly used methods are:

    • POST: For creating new resources (shifts, users, departments, roles)
    • PUT: For replacing existing resources (full update of an existing record)
    • PATCH: For partially updating existing resources (updating only specified fields)
    • DELETE: For removing resources

Data Format​

  1. Select the format in which the Nexset data will be sent to the 7shifts API from the Content Format pulldown menu. The 7shifts API accepts JSON format for all write operations. Nexla will automatically convert the data to JSON for each API call.

API Endpoint URL​

  1. Enter the URL of the 7shifts API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

    For update operations, include the ID of the resource to be updated at the end of the URL. For example, to update a specific shift, the URL would be https://api.7shifts.com/v2/company/{company_id}/shifts/{shift_id}, where {company_id} is your Company ID and {shift_id} is the ID of the shift to update.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization header or Content-Type: application/json header here — these are automatically added by Nexla using the Bearer token from your 7shifts credential and the selected content format.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this 7shifts destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the 7shifts API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the 7shifts API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the 7shifts API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the 7shifts API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured 7shifts endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to 7shifts until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.