Webhooks

Partners who want to integrate with Altibbi can use webhooks to receive notifications about events that occur in the Altibbi system.

There are two types of webhooks:

1. Status Update Webhooks

These webhooks notify the partner about the status update of a consultation. The list of statuses are as follows:

• 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 the partner about the medical recommendation in JSON format of a consultation once the doctor has prepared it.

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
        },
        {
          "name": "KETOPROFEN",
          "tradeName": "ORUVAIL S-R CAPS 100 MG",
          "strengthValue": "100",
          "packageType": "Blister",
          "packageSize": "28",
          "dosage": "2",
          "dosageUnit": "tablespoon (10ml)",
          "routeOfAdministration": "oral",
          "dosageForm": "Prolonged-release capsule, hard",
          "frequency": "Four times daily",
          "duration": 6,
          "specialInstructions": null,
          "relationWithFood": "",
          "howToUse": null
        }
      ]
    },
    "lab": {
      "lab": [
        {
          "name": "FIT Test"
        }
      ]
    },
    "doctorReferral": {
      "name": "Gastroenterologist/ Stomach & Bowel Specialist"
    },
    "followUp": [
      {
        "name": "Do Lab Test"
      },
      {
        "name": "Do the required radiation"
      },
      {
        "name": "No Follow-up - Policy Expired"
      }
    ],
    "postCallAnswer": [
      {
        "question": "doctor_notes",
        "answer": "additional note"
      },
      {
        "question": "symptoms",
        "answer": "symptoms note"
      },
      {
        "question": "diagnosis",
        "answer": "Diagnosis note"
      },
      {
        "question": "fda_drug",
        "answer": "medications note"
      },
      {
        "question": "lab_codes",
        "answer": "Lab note"
      }
    ],
    "dispense": {
      "url": "https://web.altibb.com//prescription/9EK1IhvLIwMC8rw5066cMVZXqs3",
      "pass_code": 5528,
      "qr_code": "https://services.altibbi.com/qr/https%3A%2F%2Fweb.altibb.com%2F%2Fprescription%2F9EK1IhvLIwMC8rw50jEaHIp3cEVRXqs3"
    }
  },
  "datetime": "2023-06-15T09:46:01.764869Z"
}