Skip to main content

Zendesk Chat Migration Guide

Upgrading to 1.0.0

We're continuously striving to enhance the quality and reliability of our connectors at Airbyte. As part of our commitment to delivering exceptional service, we are transitioning source Zendesk Chat from the Python Connector Development Kit (CDK) to our innovative low-code framework. This is part of a strategic move to streamline many processes across connectors, bolstering maintainability and freeing us to focus more of our efforts on improving the performance and features of our evolving platform and growing catalog. However, due to differences between the Python and low-code CDKs, this migration constitutes a breaking change.

We’ve evolved and standardized how state is managed for incremental streams that are nested within a parent stream. This change impacts how individual states are tracked and stored for each partition, using a more structured approach to ensure the most granular and flexible state management. This change will affect the [agents, bans, agents timelines, chats] streams.

Migration Steps

For Airbyte Open Source: Update the local connector image

Airbyte Open Source users must manually update the connector image in their local registry before proceeding with the migration. To do so:

  1. Select Settings in the main navbar.
    1. Select Sources.
  2. Find zendesk-chat in the list of connectors.
note

You will see two versions listed, the current in-use version and the latest version available.

  1. Select Change to update your OSS version to the latest available version.

Refresh affected schemas and reset data

  1. Select Connections in the main nav bar.
    1. Select the connection(s) affected by the update.
  2. Select the Replication tab.
    1. Select Refresh source schema.
    2. Select OK.
note

Any detected schema changes will be listed for your review.

  1. Select Save changes at the bottom of the page.
    1. Ensure the Reset affected streams option is checked.
note

Depending on destination type you may not be prompted to reset your data.

  1. Select Save connection.
note

This will reset the data in your destination and initiate a fresh sync.

For more information on resetting your data in Airbyte, see this page.