Skip to main content
EventWhen it is sent
consultation.createdA new consultation was created (scheduled or immediate).
consultation.expiredA pending consultation reached its expiration time without being used.
consultation.completedA consultation was marked as completed (session ended manually or automatically).
session_startedA participant (patient or provider) joined the video call.
session_endedA participant left or “End” was pressed (both participants are considered left at the same time).

​
Example payload – consultation.created

{
  "event": "consultation.created",
  "timestamp": "2024-12-15 10:30",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "consultationId": "550e8400-e29b-41d4-a716-446655440001",
    "participantAccess": {
      "patientUrl": "https://meet.kairoconnect.com/join/abc123?type=patient",
      "providerUrl": "https://meet.kairoconnect.com/join/abc123?type=provider"
    },
    "provider": { "name": "Dr. Ana Martínez", "professionalType": "Médico General" },
    "patient": { "documentType": "CC", "documentLastDigits": "7890", "nameInitials": "MG" },
    "scheduledAt": "2024-12-15 14:30",
    "status": "Pending",
    "createdAt": "2024-12-15 10:30"
  },
  "version": "v1"
}
For Medico Especialista, data.provider may include specialtyId, specialtyCode and specialtyName. For consultation.expired and consultation.completed events, provider is usually more concise (name and specialty as text).