{ "openapi": "3.2.0", "info": { "title": "Probatix Webhooks v1", "description": "This specification documents outgoing webhooks sent by Probatix.\n\nWebhook payload models are the same models used by the Probatix Diagnostics API v1 and Specimen Collection Kit API v1.\n\nEach delivery includes a base64-encoded HMAC-SHA256 signature of the raw request body\nin the `X-Probatix-Hmac-SHA256` header.\nCalculate the signature with your webhook signing secret and compare it in constant time before processing the payload.", "version": "1.28.0" }, "servers": [ { "url": "https://api.sandbox.probatix.de/", "description": "Sandbox environment for E2E testing." }, { "url": "https://api.probatix.de/", "description": "Production environment." } ], "paths": [], "components": { "schemas": { "RangeInterval": { "type": "object", "required": [ "label" ], "properties": { "label": { "description": "Optional human-readable label for the interval, for example `negative` or `positive`.", "example": "negative", "type": "string" }, "lower": { "description": "Optional lower boundary of the interval. Lower boundaries use `>` or `>=` operators.", "anyOf": [ { "$ref": "#/components/schemas/Boundary" }, { "type": "null" } ] }, "upper": { "description": "Optional upper boundary of the interval. Upper boundaries use `<` or `<=` operators.", "example": { "operator": "<=", "value": 5.5 }, "anyOf": [ { "$ref": "#/components/schemas/Boundary" }, { "type": "null" } ] } } }, "Boundary": { "type": "object", "required": [ "operator" ], "properties": { "operator": { "description": "Comparison operator for the boundary. Lower boundaries use `>` or `>=`; upper boundaries use `<` or `<=`.", "example": "<=", "type": "string", "enum": [ ">", ">=", "<", "<=" ] }, "value": { "description": "Boundary value used together with the operator.", "example": 5.5, "type": [ "number", "null" ] } } }, "DiagnosticOrder": { "type": "object", "required": [ "id", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticTests": { "description": "IRIs of the diagnostic tests that belong to this order.", "example": [ "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "createdAt": { "description": "Timestamp when the order was created.", "type": "string", "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when the outbound shipment was handed over.", "example": "2026-05-04T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "shipmentTracking": { "description": "Tracking details for the outbound shipment, when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "shippingAddress": { "description": "Shipping address stored for the order.", "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Up to 10 entries are supported and values must be JSON primitive values (string, number, or boolean).", "example": { "yourReference1": "abc", "yourReference2": 123, "yourFlag1": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } } } }, "ShipmentTracking": { "type": "object", "required": [ "provider", "createdAt", "updatedAt" ], "properties": { "provider": { "example": "DHL", "type": "string", "enum": [ "DHL", "Swiss Post", "OTHER" ] }, "createdAt": { "description": "Timestamp when the shipment was created.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Timestamp when the shipment was last updated.", "type": "string", "format": "date-time" }, "trackingCode": { "example": "123", "type": [ "string", "null" ] }, "url": { "example": "https://www.dhl.de/en/privatkunden/dhl-sendungsverfolgung.html?piececode=123", "type": "string", "format": "url" }, "shipmentStatus": { "description": "Normalized shipment status for informational purposes only.", "example": { "terminalStatus": true, "name": "DELIVERED", "value": "delivered" }, "type": [ "string", "null" ], "enum": [ "confirmed", "in_transit", "out_for_delivery", "delivered", "failure", "undeliverable", "returned_to_sender", "available_for_collection", null ] }, "providerStatus": { "description": "Shipment status from the provider please note some Providers are not 100% reliable and will occasionally deliver shipments without status updates.", "example": { "terminalStatus": true, "name": "DELIVERED", "value": "delivered" }, "type": [ "string", "null" ] }, "rawProviderHistory": { "description": "Raw shipment history from the provider.", "type": [ "array", "null" ], "items": {} } } }, "FullAddressInput": { "type": "object", "required": [ "address1", "zip", "city", "firstName", "lastName" ], "properties": { "address1": { "example": "Bismarckstraße 10-12", "type": "string" }, "address2": { "example": "6. OG", "type": [ "string", "null" ] }, "zip": { "example": "10625", "type": "string" }, "city": { "example": "Berlin", "type": "string" }, "countryCode": { "default": "DE", "example": "DE", "type": "string" }, "firstName": { "example": "Jane", "type": "string" }, "lastName": { "example": "Doe", "type": "string" }, "id": { "readOnly": true, "type": "string", "format": "uuid" }, "phone": { "example": "030 12345678", "type": [ "string", "null" ] }, "company": { "example": "Probatix Health GmbH", "type": [ "string", "null" ] }, "name": { "example": "Probatix Health GmbH", "type": [ "string", "null" ] } } }, "DiagnosticTest": { "type": "object", "required": [ "id", "diagnosticOrder", "diagnosticProduct", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticOrder": { "description": "IRI of the parent diagnostic order.", "example": "/v1/diagnostic_orders/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "diagnosticProduct": { "description": "IRI of the DiagnosticProduct that was ordered for this test.", "example": "/v1/diagnostic_products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "testResults": { "description": "IRIs of linked test results, sorted by `createdAt`. In most patient-facing use cases, the most recent test result is the relevant one. Older results are included for transparency and historical records.", "example": [ "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "patient": { "anyOf": [ { "$ref": "#/components/schemas/Patient" }, { "type": "null" } ] }, "specimens": { "type": "array", "items": { "$ref": "#/components/schemas/Specimen" } }, "shipmentTracking": { "description": "Tracking details for the patient-to-lab shipment when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "activatedAt": { "description": "Timestamp when the patient activated the TestKit.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "labIntakeAt": { "description": "Timestamp when the specimen arrived in the laboratory.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "replacementDiagnosticTest": { "description": "IRI of the diagnostic test that replaced this test, when it was replaced.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "replacesDiagnosticTest": { "description": "IRI of the diagnostic test this test replaces, when applicable.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "canceledAt": { "description": "Timestamp when the diagnostic test was canceled.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "completedAt": { "description": "Timestamp when the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when fulfillment of the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "description": "Timestamp when the DiagnosticTest was created.", "type": "string", "format": "date-time" } } }, "Patient": { "type": "object", "properties": { "email": { "example": "noreply@probatix.de", "type": "string", "format": "email" }, "firstName": { "example": "Jane", "type": [ "string", "null" ] }, "lastName": { "example": "Doe", "type": [ "string", "null" ] }, "gender": { "default": "X", "type": "string", "enum": [ "M", "F", "D", "X" ] }, "dateOfBirth": { "example": "1994-01-15", "type": "string", "format": "date" }, "healthInsuranceDetails": { "anyOf": [ { "$ref": "#/components/schemas/HealthInsuranceDetails" }, { "type": "null" } ] } } }, "HealthInsuranceDetails": { "type": "object", "properties": { "countryCode": { "example": "DE", "type": [ "string", "null" ] }, "provider": { "example": "Example Insurance", "type": [ "string", "null" ] }, "healthInsuranceTypeDE": { "example": "GKV", "type": [ "string", "null" ], "enum": [ "GKV", "PKV", null ] }, "subscriberIdentifier": { "description": "The insurer assigned ID for the Subscriber.", "type": [ "string", "null" ] } } }, "Specimen": { "type": "object", "required": [ "specimenCode", "createdAt" ], "properties": { "specimenCode": { "description": "Laboratory specimen code or sample identifier.", "example": "ABC-123456", "type": "string" }, "createdAt": { "description": "Timestamp when the specimen record was created.", "type": "string", "format": "date-time" }, "collectionDate": { "description": "Date when the specimen was collected.", "example": "2026-05-04", "type": "string", "format": "date" }, "collectionTime": { "description": "Time of day when the specimen was collected.", "example": "13:50:00", "type": "string", "pattern": "^\\d{2}:\\d{2}:\\d{2}$" }, "menstrualPhaseAtCollection": { "description": "Menstrual phase reported at collection time, when applicable.", "type": [ "string", "null" ], "enum": [ "follikel", "ovulation", "luteal", "menopause", null ] } } }, "TestResult": { "type": "object", "required": [ "id", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "description": "Timestamp when the test result was created.", "type": "string", "format": "date-time" }, "observations": { "type": "array", "items": { "$ref": "#/components/schemas/Observation" } }, "documents": { "description": "Embedded document metadata objects, such as PDF reports. Unlike most relations in this API, documents are included inline for convenience.", "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "labNotes": { "description": "Free-text laboratory notes attached to the test result.", "type": [ "array", "null" ], "items": { "type": "string" } }, "diagnosticTest": { "type": "string" } } }, "Observation": { "type": "object", "required": [ "id", "testResult", "loincNum", "value", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "testResult": { "description": "IRI of the parent test result.", "example": "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "loincNum": { "description": "LOINC code of the reported analyte.", "example": "2570-0", "type": "string" }, "value": { "description": "Raw value as reported by the laboratory. The API exposes it as a string to preserve the original representation. Clients should not assume the value is always safely parseable as a number.", "example": "5.5", "type": "string" }, "unit": { "description": "Measurement unit when the laboratory provides one.", "example": "µg/g", "type": [ "string", "null" ] }, "referenceRange": { "description": "Reference range or interval information supplied for the observation. The structure is interval-based: each interval may define a `lower` and/or `upper` boundary with an operator such as `>`, `>=`, `<`, or `<=`, plus an optional human-readable label such as `negative` or `positive`.", "anyOf": [ { "$ref": "#/components/schemas/ObservationReferenceRange" }, { "type": "null" } ] }, "interpretation": { "description": "Laboratory interpretation, for example positive or negative.", "example": "negative", "type": [ "string", "null" ] }, "labNotes": { "description": "Free-text notes supplied alongside the observation.", "example": [ "Kein Hinweis auf okkultes Blut im Stuhl." ], "type": [ "array", "null" ], "items": { "type": "string" } }, "createdAt": { "description": "Timestamp when the observation was created.", "type": "string", "format": "date-time" } } }, "ObservationReferenceRange": { "type": "object", "required": [ "intervals" ], "properties": { "intervals": { "description": "Reference intervals for the observation. Each interval may define a `lower` and/or `upper` boundary and can optionally provide a human-readable label such as `negative` or `positive`.", "example": [ { "label": "negative", "lower": null, "upper": { "operator": "<=", "value": 5.5 } }, { "label": "positive", "lower": { "operator": ">", "value": 5.5 }, "upper": null } ], "type": "array", "items": { "$ref": "#/components/schemas/RangeInterval" } } } }, "Document": { "type": "object", "required": [ "id", "originalFileName", "downloadPath", "mimeType", "size" ], "properties": { "id": { "example": "00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "uuid" }, "originalFileName": { "example": "example.pdf", "type": "string" }, "downloadPath": { "description": "Relative download path for the binary document.", "example": "/v1/documents/00112233-4455-6677-8899-aabbccddeeff/download", "type": "string", "format": "iri-reference" }, "mimeType": { "example": "application/pdf", "type": "string" }, "size": { "description": "Document size in bytes.", "example": 630, "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" } } }, "SpecimenCollectionKit": { "type": "object", "required": [ "id", "product", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "product": { "description": "IRI of the specimen collection kit product this kit belongs to.", "example": "/sck/v1/products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "fulfillmentData": { "description": "Optional fulfillment-specific data. Values must be JSON primitive values.", "example": { "barcode": "PX-123456789", "kitId": "KIT-2026-000123", "verified": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } }, "udi": { "description": "Parsed unique device identifier details when a UDI is linked to this kit.", "anyOf": [ { "$ref": "#/components/schemas/UniqueDeviceIdentifierDetail" }, { "type": "null" } ] }, "createdAt": { "example": "2026-06-29T10:30:00+00:00", "type": "string", "format": "date-time" }, "fulfilledAt": { "example": "2026-06-29T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "outboundShipment": { "description": "Outbound shipment for this kit when its fulfillment bundle has been shipped.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "returnShipment": { "description": "Return shipment for this kit when its fulfillment bundle has one.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "replacesKit": { "description": "IRI of the SCK kit this kit replaces.", "type": [ "string", "null" ] }, "replacementKit": { "description": "IRI of the SCK kit that replaced this kit.", "type": [ "string", "null" ] } } }, "UniqueDeviceIdentifierDetail": { "type": "object", "required": [ "normalizedText", "deviceIdentifier" ], "properties": { "normalizedText": { "example": "(01)05056751601985(10)PCCN000844(17)270831(240)KT90011", "type": "string" }, "deviceIdentifier": { "example": "05056751601985", "type": "string" }, "lotNumber": { "example": "PCCN000844", "type": [ "string", "null" ] }, "serialNumber": { "type": [ "string", "null" ] }, "additionalProductIdentifier": { "example": "KT90011", "type": [ "string", "null" ] }, "expirationDate": { "example": "2027-08-31", "type": [ "string", "null" ], "format": "date-time" }, "manufactureDate": { "example": "2026-06-15", "type": [ "string", "null" ], "format": "date-time" } } }, "SpecimenCollectionKitOrder": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "string", "format": "uuid" }, "kits": { "description": "IRIs of the specimen collection kits that belong to this order.", "example": [ "/sck/v1/kits/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "contact": { "$ref": "#/components/schemas/ShipmentContact" }, "shippingAddress": { "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Values must be JSON primitive values.", "example": { "yourReference1": "abc", "yourReference2": 123, "priority": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } }, "status": { "description": "Current SCK order status.", "example": "new", "type": "string", "enum": [ "new", "fulfilled", "canceled" ] }, "createdAt": { "example": "2026-06-29T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "example": "2026-06-30T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "outboundShipment": { "description": "Outbound shipment for this kit when its fulfillment bundle has been shipped.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "returnShipment": { "description": "Return shipment for this kit when its fulfillment bundle has one.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] } } }, "ShipmentContact": { "type": "object", "required": [ "firstName", "lastName", "email" ], "properties": { "firstName": { "example": "Jane", "type": "string" }, "lastName": { "example": "Doe", "type": "string" }, "email": { "type": "string", "format": "email", "example": "noreply@probatix.de" }, "phone": { "example": "030 12345678", "type": [ "string", "null" ] } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": {} }, "security": [], "tags": [], "webhooks": { "diagnostic_orders/created": { "post": { "tags": [ "Diagnostic Orders" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Diagnostic order created", "description": "Sent when a diagnostic order is created.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "diagnostic_orders/created" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticOrder" } } }, "required": true } } }, "diagnostic_orders/fulfilled": { "post": { "tags": [ "Diagnostic Orders" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Diagnostic order fulfilled", "description": "Sent when internal fulfillment from the Probatix Fulfillment Center to the patient is complete. An order is fulfilled when every kit that is part of the order has been fulfilled; kits can be fulfilled individually for traceability, tracking, or cost reasons.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "diagnostic_orders/fulfilled" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticOrder" } } }, "required": true } } }, "diagnostic_orders/shipment_tracking_updated": { "post": { "tags": [ "Diagnostic Orders" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Diagnostic order shipment tracking updated", "description": "Sent when automated shipment tracking updates the outbound shipment for a diagnostic order. The payload contains the current diagnostic order representation.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "diagnostic_orders/shipment_tracking_updated" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticOrder" } } }, "required": true } } }, "diagnostic_tests/activated": { "post": { "tags": [ "Diagnostic Tests" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Diagnostic test activated", "description": "Sent when a diagnostic test has been activated.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "diagnostic_tests/activated" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTest" } } }, "required": true } } }, "diagnostic_tests/replaced": { "post": { "tags": [ "Diagnostic Tests" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Diagnostic test replaced", "description": "Sent when a diagnostic test has been replaced.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "diagnostic_tests/replaced" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTest" } } }, "required": true } } }, "diagnostic_tests/canceled": { "post": { "tags": [ "Diagnostic Tests" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Diagnostic test canceled", "description": "Sent when a diagnostic test has been canceled.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "diagnostic_tests/canceled" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTest" } } }, "required": true } } }, "diagnostic_tests/fulfilled": { "post": { "tags": [ "Diagnostic Tests" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Diagnostic test fulfilled", "description": "Sent when internal fulfillment from the Probatix Fulfillment Center to the patient is complete for a diagnostic test.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "diagnostic_tests/fulfilled" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTest" } } }, "required": true } } }, "diagnostic_tests/lab_intake_registered": { "post": { "tags": [ "Diagnostic Tests" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Diagnostic test lab intake registered", "description": "Sent when lab intake is registered for a diagnostic test. This event is not guaranteed because the lab may not provide intake information, for example when its intake system is under maintenance and specimens are moved to processing manually.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "diagnostic_tests/lab_intake_registered" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTest" } } }, "required": true } } }, "diagnostic_tests/shipment_tracking_updated": { "post": { "tags": [ "Diagnostic Tests" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Diagnostic test shipment tracking updated", "description": "Sent when automated shipment tracking updates the patient-to-lab shipment for a diagnostic test. The payload contains the current diagnostic test representation.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "diagnostic_tests/shipment_tracking_updated" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTest" } } }, "required": true } } }, "test_results/evaluated": { "post": { "tags": [ "Test Results" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Test result evaluated", "description": "Sent when evaluation of a test result is complete.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "test_results/evaluated" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestResult" } } }, "required": true } } }, "sck_kits/fulfilled": { "post": { "tags": [ "Specimen Collection Kits" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Specimen collection kit fulfilled", "description": "Sent when a specimen collection kit is fulfilled.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "sck_kits/fulfilled" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKit" } } }, "required": true } } }, "sck_kits/shipment_tracking_updated": { "post": { "tags": [ "Specimen Collection Kits" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Specimen collection kit shipment tracking updated", "description": "Sent when automated shipment tracking updates a shipment exposed on a specimen collection kit. The payload contains the current specimen collection kit representation.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "sck_kits/shipment_tracking_updated" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKit" } } }, "required": true } } }, "sck_orders/created": { "post": { "tags": [ "SCK Orders" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Specimen collection kit order created", "description": "Sent when a specimen collection kit order is created.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "sck_orders/created" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKitOrder" } } }, "required": true } } }, "sck_orders/shipment_tracking_updated": { "post": { "tags": [ "SCK Orders" ], "responses": { "2XX": { "description": "Return any 2xx status to acknowledge delivery." } }, "summary": "Specimen collection kit order shipment tracking updated", "description": "Sent when automated shipment tracking updates a shipment exposed on a specimen collection kit order. The payload contains the current specimen collection kit order representation.", "parameters": [ { "name": "X-Probatix-Topic", "in": "header", "description": "The event type.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "sck_orders/shipment_tracking_updated" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Version", "in": "header", "description": "The webhook contract version.", "required": true, "deprecated": false, "schema": { "type": "string", "const": "v1" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Occurred-At", "in": "header", "description": "The time the event occurred.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "date-time" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Webhook-Id", "in": "header", "description": "A unique delivery identifier for deduplication.", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false }, { "name": "X-Probatix-Hmac-SHA256", "in": "header", "description": "Base64-encoded HMAC-SHA256 signature of the raw request body. Verify it with your webhook signing secret before processing the payload.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "Webhook payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKitOrder" } } }, "required": true } } } } }