Coassemble Migration Guide

Availability

Core Standard Plus Pro Enterprise Flex PyAirbyte

Connector type (beta)

Data replication Agent(learn more)

Support Level

Marketplace

Connector Version

0.0.66 (last updated 4 days ago)

Data workers used

0.2 per sync (Learn more)

Definition ID

85999b05-fae0-4312-a3ae-f4987f50d434

Upgrading to 0.1.0

Version 0.1.0 realigns the connector with the current Coassemble API. Coassemble retired the authentication scheme and one of the endpoints the 0.0.x connector relied on, so 0.0.x can no longer authenticate with credentials issued today and fails on the screen_types and trackings streams.

What changed

Area	0.0.x	0.1.0
Authentication	Authorization: COASSEMBLE-V1-SHA256 UserId=<user_id>, UserToken=<user_token> using the User ID / User Token fields	Authorization: COASSEMBLE:<workspace_id>:<api_key> using the new Workspace ID / API Key fields
screen_types stream	GET /api/v1/headless/screen/types	Removed. The endpoint no longer exists (the API returns 404 NOT_FOUND) and Coassemble documents no replacement.
trackings stream	One request to GET /api/v1/headless/trackings	One request per course (?id=<course id>), because the API now requires a course id. Each record gains a course_id field identifying the parent course.
Pagination	Started at page=1 with 20 records per page	Starts at page=0 (the API's first page) with 100 records per page, so the first page of courses and trackings is no longer skipped

Who is affected

All users of this connector: the credential fields are replaced, so every existing connection must be reconfigured. Users who had the screen_types stream selected must additionally deselect it.

Required actions

1. In Coassemble, open the Developer section of your workspace settings and copy your Workspace ID and generate (or copy) a workspace API Key. The legacy user token is not accepted by the new scheme.
2. Upgrade the connector to 0.1.0, then open the source settings in Airbyte and enter the Workspace ID and API Key.
3. Refresh the source schema on each connection, deselect screen_types if it was selected, and save the connection.
4. If you sync trackings, note that records now include course_id; run a sync to backfill the stream (it is full refresh only).

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.