Skip to main content

Webhooks

Partners integrating with Altibbi can use webhooks to receive real-time notifications about events occurring within the Altibbi system. There are two primary types of webhooks:

1. Status Update Webhooks​

These webhooks notify partners about changes in the status of a consultation. Supported statuses include:

  • "new"
  • "checking_medical_profile"
  • "in_progress"
  • "closed"

Sample Payload​

{
  "type": "status_update",
  "consultation_id": 72,
  "user_id": 1,
  "insurance_id": "1234",
  "policy_number": "1981",
  "old_status": "new",
  "new_status": "checking_medical_profile",
  "datetime": "2023-06-15T09:38:50.848860Z"
}

2. Recommendation Webhooks​

These webhooks notify partners when a medical recommendation is prepared by a doctor. The payload includes detailed JSON data regarding the consultation results.

Sample Payload​

{
  "type": "recommendation_data",
  "consultation_id": 72,
  "user_id": 1,
  "insurance_id": "1",
  "policy_number": "1",
  "data": {
    "icd10": {
      "symptom": [
        {
          "name": "Freckles",
          "code": "L81.2"
        }
      ],
      "diagnosis": [
        {
          "name": "Fascioliasis",
          "code": "B66.3"
        }
      ]
    },
    "drug": {
      "fdaDrug": [
        {
          "name": "PIMOZIDE",
          "tradeName": "ORAP FORTE TAB 4 MG",
          "strengthValue": "4",
          "packageType": "Blister",
          "packageSize": "20",
          "dosage": "2",
          "dosageUnit": "capsule",
          "routeOfAdministration": "oral",
          "dosageForm": "tablet",
          "frequency": "Four times daily",
          "duration": 5,
          "specialInstructions": null,
          "relationWithFood": "",
          "howToUse": null
        }
      ]
    },
    "lab": {
      "lab": [
        {
          "name": "FIT Test"
        }
      ]
    },
    "doctorReferral": {
      "name": "Gastroenterologist"
    },
    "followUp": [
      {
        "name": "Do Lab Test"
      }
    ],
    "postCallAnswer": [
      {
        "question": "doctor_notes",
        "answer": "additional note"
      }
    ],
    "dispense": {
      "url": "https://web.altibbi.com/prescription/...",
      "pass_code": 5528,
      "qr_code": "https://services.altibbi.com/qr/..."
    }
  },
  "datetime": "2023-06-15T09:46:01.764869Z"
}