Skip to main content
All the changes listed below are considered to be backwards compatible by Helium Id. Make sure to set up your systems in a flexible manner so that they are able to gracefully handle these changes without breaking.
  • Adding new properties (e.g., strings, objects, arrays) to existing API responses.
  • Changing the order* of properties in existing API responses (i.e., the order of strings, objects, arrays).
  • Adding new API resources, e.g., adding new API endpoints.
  • Adding new optional request parameters to existing API endpoints.
  • Changing the length or format of opaque** strings, such as error messages, object IDs, etc.
  • Adding new event types to webhooks.
  • Adding new properties (e.g., strings, objects, arrays) to webhook payloads.
Important Note for Webhooks: Your webhook listeners should gracefully handle unfamiliar event types without throwing errors.
* Property order: As a general note on the order of properties in the responses, keep in mind that the order is not static. This means that the order you see in your actual API call responses may differ from the order you see in the Helium Id documentation.
** Opaque strings: This means data that your system should be able to just transmit or store, not interpret or parse for logic.