Skip to main content

Quick Start

This guide walks you through setting up your first calendar sync with CalendarPipe. By the end, you will have two calendars connected and events flowing between them through a gate function.

Prerequisites

Before you begin, make sure you have:

  • Two calendars to sync between (e.g., a Google Calendar and a Microsoft Calendar, or two Google Calendars from different accounts)
  • Access to the email accounts associated with those calendars
info

CalendarPipe syncs events one way -- from a source calendar to a target calendar. To sync both ways, you will create two sync rules (one in each direction).

Step 1: Sign up

Go to calendarpipe.com and create your account. You can sign up with email and password or use Google or Microsoft sign-in.

Screenshot: CalendarPipe sign-up page

After signing up, you will land on the CalendarPipe dashboard.

Screenshot: Dashboard after first login

Step 2: Connect your first calendar

Navigate to Calendar Connections in the left sidebar and click Add Connection.

Choose your calendar provider:

  • Google Calendar -- Sign in with Google and grant calendar access (detailed guide)
  • Microsoft Calendar -- Sign in with Microsoft and grant calendar access (detailed guide)
  • Apple Calendar -- Enter your Apple ID and an app-specific password (detailed guide)

Follow the prompts for your chosen provider. Once connected, select which calendars you want CalendarPipe to access.

Screenshot: Successful calendar connection

tip

Repeat this step to connect your second calendar. You need at least two calendars to create a sync rule -- one as the source and one as the target.

Step 3: Create a sync rule

Navigate to Sync Rules in the left sidebar and click Create Rule.

  1. Name your rule -- Choose a descriptive name like "Work to Personal (filtered)"
  2. Select source calendar -- The calendar events will be read from
  3. Select target calendar -- The calendar events will be written to
  4. Choose delivery mode -- Select Direct (default) to write events directly to the target calendar

Screenshot: Create sync rule dialog

For more details on delivery modes and options, see the Sync Rules guide.

Step 4: Choose a gate function

Every sync rule needs a gate function that decides which events to sync and how. For your first rule, choose one of the built-in templates:

  • Pass All Events -- Sync everything without modification (good for getting started)
  • Block Personal Events -- Skip events with "Personal" in the title
  • Set Events as Free -- Sync all events but mark them as free on the target calendar

You can always change or customize your gate function later. To learn more about gate functions, see the Gate Functions overview.

Step 5: Verify your sync

After creating your sync rule, CalendarPipe will start syncing events automatically. The first sync happens within a few minutes.

To verify everything is working:

  1. Open your target calendar in its native app (Google Calendar, Outlook, etc.)
  2. Look for events from your source calendar appearing on the target
  3. Check the sync rule in CalendarPipe for the last sync timestamp and event count

Screenshot: Synced event visible in target calendar

Sync Intervals
  • Free plan: Events sync every 15 minutes
  • Pro plan: Events sync every 5 minutes

Changes made in your source calendar will appear in the target calendar at the next sync interval.

What happens next

Your sync rule is now active. CalendarPipe will automatically check your source calendar for new, updated, and deleted events at each sync interval and apply your gate function to each one.

Here are some things you can do next:

  • Add more connections -- Connect additional calendars from any supported provider
  • Create more rules -- Set up sync rules between different calendar pairs
  • Customize gate functions -- Write custom logic to filter and transform events exactly how you want
  • Upgrade to Pro -- Get faster sync intervals, ICS feed support, AI-generated gate functions, and more