API and Platform Changes
Change Overview
To maximize on all possible usage of the Fluz API, we recommend building robust and resilient integrations that can adapt to API and platform changes.
When changes occur on the Fluz platform and GraphQL API, the Fluz team reviews them to assess their impact and communicates with you proactively about the upcoming changes. The following table provides details of each phase for implementing platform changes and the activities that occur in each phase.
| PHASE | ACTIVITIES |
|---|---|
| Planning | Once a change is determined, change planning begins. This includes documenting the change and its impact. |
| Communication and documentation | The Fluz team ensures that the change's documentation is completed and that your usage is reviewed to determine its impact on you. Fluz creates communication that includes the change's description, the reason for the change, the potential impact on you from the change, and the timing. For more information on communication timelines, see Additive Changes and Breaking Changes. |
| Implementation | Fluz ensures the execution of communication to you by Fluz Customer Support. This includes performing the change as documented. |
| Retrospective | After the change is launched, Fluz holds a retrospective to reflect on the change management process. |
Additive Changes
Additive changes refer to modifications to notifications and/or Fluz API schema on existing new features, functionality, or resources without altering or removing existing components.
Fluz will provide a 7+ day notice before releasing additive changes that require an action or a change from API users.
Fluz will not provide any advance notice before releasing additive changes that do not require any action from the API user or impact existing features.
Breaking Changes
Breaking changes refer to modifications to notifications and/or Fluz API schema that alter existing behavior in a way that may cause existing client applications and integrations to break or malfunction.
Fluz provides +14 days notice before releasing breaking changes.
New Feature Notifications
As new functionality for the platform is developed, Fluz will send out notification emails to our members. We will also update the help center with additional information about those new features. The emails will contain details about the new features. If the new feature is available via the API, we will update the documentation accordingly.
Updated about 2 months ago