June 2024: API News and Roadmap
We're thrilled to share some exciting news! At Healthie, we are committed to enhancing your developer experience. In the coming months, we'll be investing in refining our documentation, SDKs, Webhooks, and more to make your work smoother and more efficient.
To keep you in the loop with all the latest and greatest updates, we're launching periodic API updates packed with valuable insights and sneak peeks into our roadmap.
Recent API Releases
We rolled out the following API updates effective May 1, 2024: Updated GraphQL API error messaging:
- Current GraphQL error messaging is generic and does not currently provide detailed information about the cause of the error.
- New error messaging conforms to the latest GraphQL specifications, improving the developer experience.
- For the next 180 days both the current non-conforming (generic) errors and the new conforming (specific) errors will be visible in the platform.
- As of November 1, 2024 all non-conforming errors will be removed. deprecated.
Additional API & webhook releases
- Add Thin Payloads: We have added a feature that we are calling “thin payloads”. Thin payloads provide you with changed fields when receiving an “updated” webhook, so you know what fields changed.
- Added form_answer_group_id to update CMS mutation.
- Set a warning email to send to the end user after 1 day if a webhook fails.
- Made an update to ensure that webhooks encountering an error “recipient server timeout errors” and “server no longer exists” errors are sent to the failed state.
- Full rollout of cursor-based pagination.
- We are changing the pharmacy GraphQL query spelling, but will continue to support the misspelled phamracy query until Thursday, September 14, 2024.
All features added to the platform are also available directly via the API. You can find full API updates in our monthly release notes.
API Roadmap Insights ⚡
- GraphQL standardization for dates & IDs and more.
- GraphQL validations - multi-phased work
By leveraging GraphQL for validations, the API development process can benefit from real-time error detection, detailed and informative error messages, customizable validation based on usage patterns, adherence to standard specifications, and tailored solutions for specific needs. This approach not only improves the developer experience but also significantly enhances the end-user experience, addressing previous feedback about the API experience – making it more intuitive and reliable.
GraphQL for API validations supports the following:
- Real-Time Feedback and Tooling: Alerts developers to issues as they happen, allowing for immediate customer feedback and error correction.
- Enhanced Error Messages: Provides specific, informative errors that explain the cause, improving user understanding and experience.
- Customizable Validations: Tailors validations based on frequently used APIs, ensuring the most impactful areas are prioritized.
- Conformance to Standards: Adheres to the GraphQL specification, ensuring compatibility, consistency, and reliability.
- Tailored Solutions: Built specifically for Healthie, addressing unique requirements and feedback, enhancing both internal and external usability.
👉 Learn more about upcoming releases in our Product Portal. You can subscribe to the releases that you want to closely follow, and receive real-time updates as they go live.
If you have any questions about new or upcoming releases, please reach out to