APIs change over time; new endpoints are added, older ones are removed, and behavior sometimes shifts. To keep your integrations working smoothly, Cyclr regularly updates the Connectors in the Application and Utility Libraries to reflect those changes.
Each time a Connector is updated, it’s published as a new Connector Release, a versioned snapshot of a Connector’s structure and functionality at a given point in time.
Installed “instances” of Connectors reference a particular Connector Release which determines how they function. Steps used within your Templates and Cycles (your “integrations”) also – and independently from their Connector instances – reference Connector Releases too.
It’s common for Connector instances and Steps from them to be referencing different Connector Releases.
How do I know when a new Release is available? #
Cyclr indicates when a new Connector Release is available by showing:
- an Upgrade button on the Connector Settings page, or;
- an Update banner inside affected Steps in the Builder.
If you submitted a Support Ticket to request us to make a particular change to a Connector, you will be notified on that ticket once it is available and whether only a Step update or a full Connector upgrade is needed to use that change.
Any major Connector changes that require action by all partners using it will be notified by Cyclr via the in-app messaging, shown on your Console’s Dashboard.
When to Upgrade #
Cyclr allows you to have different Releases used by your Connectors and Steps. Functionality can remain stable without upgrading every time a new Connector Release is available.
Installed Template Connectors and Account Connectors are not automatically updated to the latest Releases when new ones are made available, and nor are the Steps in your integrations. This is to ensure that changes we make as part of a new Connector Release do not immediately change your existing Cycles, Templates or installed Connectors.
Upgrading an instance of a Connector clears its authentication and stops any running Cycles or Templates that use it so you should only upgrade when it’s necessary or clearly beneficial.
If you notice an upgrade option, you should evaluate the release notes of that Connector Release first; if your integrations are running without issue, and you haven’t been notified of a required upgrade, staying on the current Release is perfectly acceptable.
Connector Release Notes #
To view what’s changed on a particular Connector Release:
- Navigate to Cyclr Console → Connectors → Application Connector Library.
- Search for a Connector then select the “…” button and choose Releases, then expand any row to read what has changed.
- Reading those notes should help you decide whether an upgrade is necessary or beneficial.
“Should I upgrade?” checklist: #
- Is a newer Connector Release available?
Check the Connector’s Settings page for an “Upgrade” button at the top, or a Step’s Step Setup popup for an “Update” banner. - Is your integration currently working as expected?
If your Templates and Cycles are running without issue, there may be no need to upgrade. - Is the change relevant to your use case?
Does the update make a change you had requested or address a situation you had queried?
Review the Connector Release notes by going to:
Cyclr Console → Connectors → Application Connector Library → “…” → Releases - Were you informed of a specific change?
Did we notify you (either through a Support Ticket or via Cyclr’s in-app messaging) that an update was required?
If yes, follow the provided guidance. Depending on the changes made, you may need to upgrade Connector instances or just specific Steps.
If you’ve determined that upgrading a Connector and/or your Steps is necessary, you will want to make sure they are updated in all the relevant areas, including Templates and Cycles that use the older Release.
Upgrading Connectors #
Open a Connector instance’s Settings page and look for the “Upgrade” button at the top which is displayed when a newer Release exists. Selecting it updates that instance of the Connector to the latest Release. It does not upgrade any Steps, however, which can be upgrade separately.
When upgrading a Connector instance:
- The Connector’s existing authentication is cleared so it must be re-authenticated after upgrading.
- Any integrations (so Templates or Cycles) that use Steps from that particular instance of the Connector will be stopped. You can restart them once it has been re-authenticated.
Upgrading Steps #
To upgrade a Step in either a Template or a Cycle, open it in the Builder and select the Step’s Step Setup button.
If a “Step Update Available” banner is displayed at the top of the popup, a newer Connector Release is available for that Step.
Selecting the “Upgrade” option within the banner will upgrade that Step.
Your Template or Cycle must be stopped before its Steps can be upgraded.
Upgrading Steps within a Cycle #
Upgrading Steps directly within your Cycles is appropriate for those that have been created within your Accounts as one-off or ad-hoc integrations. For those installed from a Template however, you should instead create a new Template Release as a way to push out those changes to all related Cycles, saving you manually updating lots of Cycles.
Upgrading Steps within a Template #
For Cycles that were installed from a Template, the recommended route is:
- create a new Template Release within the existing Template.
- Upgrade any appropriate Steps within that new Template Release.
- perform any necessary testing to confirm it’s ready.
- set that Template Release to “Live”.
- push it out to existing Cycles to update them.
Viewing the Connector Release used by a Step and its Connector #
Sometimes an instance of a Connector may be using the latest Release, but a Step using one of its Methods could be using an earlier Release.
To identify that situation:
- From within the Builder, open a Step’s Step Setup popup.
- If the top banner displays “Update”, a newer Connector Release is available for that Step.
- You can confirm that by expanding the Advanced Settings area and scrolling to the bottom to see the following values:
- Method Release Version: the Connector Release that particular Step is using.
- Account Connector Release Version: the Connector Release used by that Step’s parent Connector instance.
If the Method Release Version and Account Connector Release Version differ, they are using different Connector Releases.
They can continue to be different or you may wish to bring the Step forward to use the latest Release. Review the release notes to determine whether an update is necessary.
Which Release will be used when installing a Connector?
- Cyclr will use the latest Release of a Connector when it’s installed in these situations:
- Installing a Connector manually through the interface, whether as a Template Connector in your Template Library, or an Account Connector within an Account.
- Through the Cyclr API by using an endpoint where the Connector to install is identified by providing its Name.
- Cyclr will use a specific Release – which may not be the latest – in these situations:
- When installing a Template into an Account that doesn’t already have a Connector of the type used in the Template (or where “Fresh Installation” is configured for that Connector in the Template’s Settings), Cyclr will install the same Connector Release as used by the Template.
- Through the Cyclr API by using an endpoint where the Connector to install is identified by an Id – that Id indicates the Release of the Connector to be used.
