2 Apr 2024: Backwards incompatible change on Flow Results API

Neelke Stadler Updated by Neelke Stadler

If you export journey insights for your chat service via the Flow Results API this backwards incompatible change requires action from you before April 15th. 

If you do not use the API explicitly and only use the product you can ignore this email. 

What is changing and why?

Our implementation of the Flow Results API was not completely aligned with the more general JSON API specification in how we represent the data, links, and relationships attributes in the JSON response. This meant that off the shelf JSON API clients could not be used with the Turn.io API. The change aligns our response with the JSON API specification and allows customers to use existing off the shelf JSON API clients.

What actions do you need to take?

If you have implemented an HTTP client for the Flow Results API please update it as per this documentation to ensure it expects the relationships key to be nested under the data key instead of being a top-level attribute alongside data.

When will this change take effect?

We will ship the backwards incompatible change on Monday April 15th, 2024. To prevent any issues make sure all actions on your end are completed before that date. 

If you have any questions do not hesitate to contact us.

Was this article helpful?

4 Apr 2024: Reactions

27 Mar 2024: First-time visitors