Skip to main content
This page provides a visual summary of the consultation lifecycle, typical integration flow, and API structure.

​
Consultation states

A consultation goes through the following states. Webhook events (consultation.created, consultation.expired, consultation.completed, session_started, session_ended) reflect these transitions.
StateDescription
PendingConsultation created; patient and provider can join using the URLs and PIN.
In progressAt least one participant has joined the video call (session_started).
ExpiredExpiry time reached without the consultation being used.
CompletedSession was closed (manually or automatically); event consultation.completed.
The status field in the API response and webhook payloads may use values such as Pending; the diagram states are conceptual and aligned with webhook events.

​
Typical integration flow

Simplified flow: your system creates the consultation, receives URLs and PIN, and optionally receives real-time events via webhook.
  • Creation: your system calls POST /consultations and receives participantAccess (URLs) and accessPin.
  • Usage: patient and provider join with those URLs; if you have webhooks, you receive session_started and session_ended.
  • Closure: when the session ends, consultation.completed is sent; you can fetch detail with GET /consultations/{consultationId}.

​
API structure

High-level view of resources and how they relate to your organization.
ResourceDescription
ConsultationsCreate consultations (POST) and get detail by consultationId (GET).
ProvidersList providers with optional filters (GET /providers).
Organization profileYour organization data and settings (GET /organizations/profile).
WebhooksThe platform sends events to your URL; you verify the signature and process them.

​
Scheduled vs immediate consultation

Quick distinction based on whether scheduledAt is sent in POST /consultations:
  • Scheduled: include scheduledAt in yyyy-MM-dd HH:mm format (organization timezone). At least 15 minutes in advance.
  • Immediate: do not send scheduledAt; the consultation is available right away.

​
See also