Webhooks

Partners can use webhooks to receive real-time notifications about events occurring on the Altibbi platform. This is often used for server-side syncing with your own database.

1- Status Update Webhooks

These notify your server when a consultation status changes.

Possible Statuses:

• new
• checking_medical_profile
• in_progress
• closed

Sample Payload:

{
  \"type\": \"status_update\",
  \"consultation_id\": 72,
  \"user_id\": 1,
  \"old_status\": \"new\",
  \"new_status\": \"checking_medical_profile\",
  \"datetime\": \"2024-03-20T10:00:00Z\"
}

2- Recommendation Webhooks

These notify your server when a doctor has finalized a medical recommendation. The payload contains the complete JSON structure of the recommendation (ICD10 codes, prescriptions, and lab tests).

Sample Payload Structure:

{
  \"type\": \"recommendation_data\",
  \"consultation_id\": 72,
  \"user_id\": 1,
  \"data\": {
    \"icd10\": { ... },
    \"drug\": { ... },
    \"lab\": { ... },
    \"doctorReferral\": { ... },
    \"followUp\": [ ... ]
  },
  \"datetime\": \"2024-03-20T10:05:00Z\"
}

For details on managing these webhooks and providing your endpoint URL, please contact the Altibbi Support Team.