Add new source connector Shiftbase

[merttkarabulut]

What

New Shiftbase Source Connector

New source connector has been added for Shiftbase.
This page contains the setup guide and reference information for the Shiftbase source connector.

Prerequisites

To set up the Shiftbase source connector, you'll need:

• A Shiftbase account with API access
• An Access Token generated from the Shiftbase App Center
• The Account Name for tracking purposes (you can use any identifier)

Generating an Access Token

1. Log in to your Shiftbase account
2. Navigate to the App Center
3. Generate a new API Access Token
4. Copy and securely store the token — you'll need it for the connector configuration

Setup Guide

Set up Shiftbase

For Airbyte Cloud

1. Log into your Airbyte Cloud account
2. Click Sources and then click + New source
3. On the Set up the source page, select Shiftbase from the Source type dropdown
4. Enter a name for the Shiftbase connector
5. Enter your Account Name (an identifier for tracking)
6. Enter your Access Token from the Shiftbase App Center
7. Enter your Start Date for historical data sync (format: YYYY-MM-DD)
8. Click Set up source

For Airbyte Open Source

1. Navigate to the Airbyte Open Source dashboard
2. Click Sources and then click + New source
3. On the Set up the source page, select Shiftbase from the Source type dropdown
4. Enter a name for the Shiftbase connector
5. Enter your Account Name (an identifier for tracking)
6. Enter your Access Token from the Shiftbase App Center
7. Enter your Start Date for historical data sync (format: YYYY-MM-DD)
8. Click Set up source

Multiple Accounts

The Shiftbase connector supports syncing data from multiple Shiftbase accounts simultaneously. When configuring the connector, you can add multiple account configurations, each with its own access token and account name.

Supported Sync Modes

The Shiftbase source connector supports the following sync modes:

Feature	Supported
Full Refresh Sync	Yes
Incremental - Append Sync	Yes
Replicate Incremental Deletes	No
SSL connection	Yes
Namespaces	No

Supported Streams

The Shiftbase source connector supports the following streams:

Stream	Sync Mode	Description
departments	Full Refresh	Internal departments within the Shiftbase account
employees	Full Refresh	List of employees (PII fields like name are excluded)
absentees	Full Refresh, Incremental	Records of employee absences and leave
employee_time_distribution	Full Refresh	Distribution of worked and planned hours per employee
availabilities	Full Refresh, Incremental	Employee availability slots and preferences
shifts	Full Refresh	Scheduled work shifts and roster details
users	Full Refresh	User account details (PII excluded, flattened structure)
employees_report	Full Refresh	Employees report data
timesheet_detail_report	Full Refresh	Detailed timesheet report data
schedule_detail_report	Full Refresh	Detailed schedule report data

Performance Considerations

The Shiftbase API has rate limiting in place. The connector handles rate limits automatically with exponential backoff. If you encounter rate limit issues, consider:

• Reducing the sync frequency
• Using incremental sync where available to minimize API calls

How

Review guide

User Impact

Can this PR be safely reverted and rolled back?

• YES 💚
• NO ❌

[CLAassistant]

All committers have signed the CLA.

[octavia-bot]

Note

📝 PR Converted to Draft

More info...

Thank you for creating this PR. As a policy to protect our engineers' time, Airbyte requires all PRs to be created first in draft status. Your PR has been automatically converted to draft status in respect for this policy.

As soon as your PR is ready for formal review, you can proceed to convert the PR to "ready for review" status by clicking the "Ready for review" button at the bottom of the PR page.

To skip draft status in future PRs, please include [ready] in your PR title or add the skip-draft-status label when creating your PR.

[github-actions]

👋 Welcome to Airbyte!

Thank you for your contribution from merttkarabulut/airbyte! We're excited to have you in the Airbyte community.

If you have any questions, feel free to ask in the PR comments or join our Slack community.

💡 Show Tips and Tricks

PR Slash Commands

As needed or by request, Airbyte Maintainers can execute the following slash commands on your PR:

• /format-fix - Fixes most formatting issues.
• /bump-version - Bumps connector versions.
• /run-connector-tests - Runs connector tests.
• /run-cat-tests - Runs CAT tests.
• /run-regression-tests - Runs regression tests for the modified connector(s).
• /build-connector-images - Builds and publishes a pre-release docker image for the modified connector(s).
• /publish-connectors-prerelease - Publishes pre-release connector builds (tagged as {version}-preview.{git-sha}) for all modified connectors in the PR.
• /ai-review - AI-powered PR review for connector safety and quality gates.
• /force-merge reason="<A_GOOD_REASON>" - Force merges the PR using admin privileges, bypassing CI checks. Requires a reason.

Tips for Working with CI

1. Pre-Release Checks. Please pay attention to these, as they contain standard checks on the metadata.yaml file, docs requirements, etc. If you need help resolving a pre-release check, please ask a maintainer.
   • Note: If you are creating a new connector, please be sure to replace the default logo.svg file with a suitable icon.
2. Connector CI Tests. Some failures here may be expected if your tests require credentials. Please review these results to ensure (1) unit tests are passing, if applicable, and (2) integration tests pass to the degree possible and expected.
3. (Optional.) BYO Connector Credentials for tests in your fork. You can optionally set up your fork with BYO credentials for your connector. This can significantly speed up your review, ensuring your changes are fully tested before the maintainers begin their review.

📚 Show Repo Guidance

Helpful Resources

• PR Guidelines: Check our guidelines for contributions.
• Breaking Changes Guide: Guide to breaking changes, migration guides, and upgrade deadlines.
• Developing Connectors Locally: Learn how to set up your environment and develop connectors locally.
• If you enable BYO Connector Credentials within your fork, you can view your test results here:
  

📝 Edit this welcome message.