Getting Started

This guide walks you through the essential steps to integrate your scheduling system with Seamlr.

Integration Overview

1. Contact Seamlr to register as a scheduling provider and obtain API credentials

2. Implement webhook endpoints to notify Seamlr when shifts change

3. Expose REST API endpoints so Seamlr can fetch shift details and sync assignments

4. Configure entity mappings for outlets and roles

5. Activate the integration via the activation endpoint

Tip

Start with the Integration Overview to understand the architecture before diving into implementation details.

Key Concepts

Data Ownership

Seamlr follows a clear data ownership model:

• Provider owns: Shift times, locations, roles, number of positions
• Seamlr owns: Candidate assignments, profiles, booking status

Event Flow

1. Provider sends webhook when a shift is created/updated/deleted
2. Seamlr queues the event for processing
3. Seamlr fetches full shift details via Provider API
4. Seamlr matches and assigns candidates
5. Seamlr syncs assignments back to Provider

Next Steps

Integration Overview Deep dive into the architecture and data ownership model

Webhook Events Learn how to send webhooks to Seamlr

API Requirements Endpoints your system needs to expose