Core data models
Abi integrations commonly persist identifiers and selected status fields from four core models. Field definitions, enumerations, examples, and requiredness are maintained in the OpenAPI contract and appear in the response sections of the linked operations.
User account
Section titled “User account”A user account represents one of your customers in Abi. It links your optional uniqueId to Abi’s id, service language, location context, physician-country configuration, contact details where applicable, and current access status.
See the generated Get a user account response.
Subscription
Section titled “Subscription”A subscription represents a period during which a user can access the configured service. Integrations typically retain its identifier, active state, start/end dates, cancellation time, and renewal relationship.
See the generated Get a subscription response.
Consultation
Section titled “Consultation”A consultation is the durable record of a user’s medical question, including its status, questions, approved attachments, and—once available—the response and relevant professional information.
See the generated Get a consultation response.
Webhook event
Section titled “Webhook event”A webhook event is the asynchronous notification Abi sends to a registered endpoint. It identifies the event type and the associated consultation and user so your system can retrieve current data if required.
See the generated Format a webhook event response.
Keeping contracts current
Section titled “Keeping contracts current”These models are generated from OpenAPI rather than duplicated here. When the published contract changes, the corresponding generated response documentation changes with it; update this page only when the product meaning or integration guidance changes.