Skip to main content
This guide describes deprecation and sunset. It does not publish a notice period or a lifecycle state that has not been announced. API Versioning and Compatibility explains how versions change. Webhook event compatibility explains event contract rules and migration to a new event type.

​
Deprecated

Deprecated means OneFunnel has announced that an API version, endpoint, field, or webhook event type should not be used for new work. A deprecated contract remains available until its sunset. If no sunset date has been announced, do not infer one.

​
Sunset

Sunset means the announced time after which that contract is no longer available. A sunset date applies only when the announcement includes one. There is no default notice period and no default overlap with the replacement.

​
What an announcement includes

When a contract is deprecated, the announcement identifies:
  • The API version, endpoint, field, or webhook event type that is deprecated.
  • The replacement or migration path, when one exists.
  • The sunset date, when one has been set.
Further lifecycle states are documented only in the announcement that introduces them. Do not treat an unpublished state as a commitment.

​
What you should do

  1. Review the deprecation announcement in the Changelog.
  2. Identify the affected endpoints, fields, or webhook event types.
  3. Review the published migration path.
  4. Update and test your integration against the supported contract.
  5. Finish the migration before the announced sunset date.
If you are unsure whether an announcement affects your integration, contact the OneFunnel support team before changing your production implementation.