Calendly Migration Guide

Availability

Core Standard Plus Pro Enterprise Flex PyAirbyte

Connector type

Data replication Agent(learn more)

Support Level

Marketplace

Connector Version

0.4.2 (last updated a day ago)

Sync Success Rate

Medium

Usage Rate

High

Data workers used

0.2 per sync (Learn more)

Definition ID

b8f2cbee-b073-4dd8-9b80-97d7bae967a4

Upgrading to 1.0.0

Risk of permanent data loss

Clearing a stream deletes its destination data. Calendly doesn't return deleted events and invitees, so their rows aren't restored, and in append modes a clear also removes every earlier version of each record. Back up the affected tables before you clear anything, and clear only what the destination notes below ask for.

What changed

• scheduled_events: the incremental cursor changed from start_time to updated_at. Every sync requests events from your start date, and incremental syncs emit the events whose updated_at changed, including upcoming events, cancellations and reschedules. Events updated while a sync runs are left out of that sync, with their invitees, in every sync mode, and the next sync emits them; in Full refresh | Overwrite their rows are missing until then. The existing datetime fields start_time, end_time, created_at, updated_at, cancellation.created_at, event_guests[].created_at, event_guests[].updated_at, event_memberships[].buffered_start_time and event_memberships[].buffered_end_time now declare date-time.
• event_invitees: its state follows scheduled_events, and all invitees of each new or changed event are read again. created_at, updated_at and cancellation.created_at now declare date-time; questions_and_answers[].position is now an integer.
• api_user: created_at and updated_at now declare date-time.
• event_types: created_at and updated_at now declare date-time; position, custom_questions[].position and the duration_options items are integers.
• groups: created_at and updated_at now declare date-time.
• organization_memberships: created_at, updated_at, user.created_at and user.updated_at now declare date-time.

Who must act

You don't need to clear scheduled_events or event_invitees for the cursor change. Version 1.0.0 ignores the old start_time state, so the first sync after the upgrade reads every event that starts on or after your start date with all of its invitees, including the bookings and cancellations that earlier versions missed. In Incremental | Append + Deduped mode these rows replace the existing ones by uri; in Incremental | Append mode the first sync appends one more copy of each event and invitee. If you moved your start date later after the first sync, move it back first.

Every connection must refresh the source schema so the new column types apply. Whether you also need to clear a stream depends on your destination; see the destination notes.

If you raised lookback_days to work around the incremental limitation of earlier versions, set it back to 0: a larger value now re-emits every event updated in that window and reads its invitees again on every sync. If you switched scheduled_events and event_invitees to Full refresh for the same reason, you can switch them back to Incremental | Append + Deduped; Full refresh reads the invitees of every event on every sync.

Destination notes

The retyped top-level columns are created_at and updated_at on all six streams, start_time and end_time on scheduled_events, and position on event_types. Nested fields (for example cancellation.created_at or questions_and_answers[].position) and event_types.duration_options stay JSON in warehouse destinations and change only in S3 Data Lake, GCS Data Lake and typed file formats.

• BigQuery, Snowflake, Redshift, Databricks and Postgres convert the existing text and decimal columns to timestamps and integers in place. Calendly's values match the new types, so no clear is needed.
• Postgres and Redshift: drop every view that reads a retyped column, including SELECT * views, before the first 1.0.0 sync, and recreate it afterwards. Postgres can't change the type of a column a view depends on, and Redshift can't drop it unless Drop tables and columns with CASCADE is on (which drops those views), so the sync fails.
• ClickHouse changes the column types in place but turns the existing timestamp text into empty values. For any of the six streams synced in an append mode, and for event_types in Incremental | Append + Deduped mode, back up the table and clear the stream before the first 1.0.0 sync. scheduled_events and event_invitees in Incremental | Append + Deduped mode are rebuilt by the first sync's full re-read. Full refresh | Overwrite streams are rebuilt and need nothing.
• S3 Data Lake and GCS Data Lake can't change these column types in place, including event_types.position and event_types.duration_options. For streams synced in an append or incremental mode, every sync of the connection fails with Schema evolution for column ... is not allowed until you clear them, so clear those streams when you refresh the schema. Full refresh | Overwrite streams are rebuilt on the next sync.
• S3 and GCS with Avro or Parquet write the new types in new files; files written earlier keep the old types, so readers that combine old and new files must handle both.
• MotherDuck and DuckDB keep the existing column types until a clear or a Full refresh | Overwrite sync recreates the table. JSONL and CSV outputs don't change.

Downstream consumers

Update SQL queries, dbt models, dashboards and exports that read the retyped top-level columns listed above, and object-storage consumers that read the nested fields in Avro or Parquet.

Migration steps

1. Back up the affected destination tables.
2. On Postgres or Redshift, drop the views that read retyped columns.
3. Upgrade the connector and refresh the source schema.
4. Clear only the streams the destination notes list for your destination and sync mode.
5. Sync, confirm the streams complete, and recreate any views you dropped.

Rollback

Rolling back to a 0.x version brings back the incremental defect: depending on the saved state it either reads again from your start date or resumes from an old upcoming-event cursor, and either way its incremental syncs stall. If you roll back, sync scheduled_events and event_invitees in Full refresh while you stay on 0.x. Don't refresh the schema after rolling back on a destination that already converted the columns, or typed destinations convert the timestamps and integers back to text and decimals in a different text format.

Connector upgrade guide

Review the following information to prepare for and execute your upgrade.

Review the changelog

Before updating a connector, review the changelog to understand the changes and their potential impact on your existing connections. Find the changelog for any connector by navigating to the bottom of the documentation for that connector. Major version releases also include a migration guide.

Plan for major updates

Major updates may require you to adjust connection settings or even make changes to your data pipelines. Allocate enough time and resources for this. Use the migration guide to ensure your transition process goes smoothly.

Airbyte provides tooling that guarantees safe connector version bumps and enforces automated version bumps for minor and patch updates. You always need to manually update for major version bumps.

Self-managed plans: pin a specific version if you can't update

If you're unable to upgrade to the new version of a connector, you can pin that connector to a specific version.

1. In the navigation bar:

   • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

   • If you're on any other plan, click Workspace settings > Sources/Destinations.

2. Edit the entry for the connector you want to pin.

3. Set the Default Version to the version you want to use.

Self-managed plans: update the local connector image

If you self-manage Airbyte, you must manually update the connector image in your local registry before proceeding with the migration. Follow the steps below.

1. In the navigation bar:

   • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

   • If you're on any other plan, click Workspace settings > Sources/Destinations.

2. Find the connector you want to update in the list of connectors.

   note

   Airbyte lists two versions, the current in-use version and the latest version available.

3. Click Change to update your OSS version to the latest available version.

Update the connector version

Update each instance of the connector separately. If you have multiple instances of a connector, updating one doesn't affect the others.

1. In the navigation bar:

   • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

   • If you're on any other plan, click Workspace settings > Sources/Destinations.

2. Select the instance of the connector you wish to upgrade.

3. Select Upgrade.

4. Follow the prompt to confirm you are ready to upgrade to the new version.

Clear data from affected streams

After upgrading a connector with a breaking change, you must refresh affected schemas and clear your data.

1. In the nav bar, click Connections.

2. Find the connection affected by the upgrade.

3. Click the Schema tab.

4. Click Refresh source schema (looks like ). When Airbyte finishes, it shows you any detected schema changes.

5. Click OK.

6. Click Save changes

7. Clear the data for the streams affected by this upgrade.

Once the clear is complete, you can begin syncing your data again as usual.