Probatix Documentation
Probatix Webhooks v1Diagnostic Orders

Diagnostic order fulfilled

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.

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.

All webhook requests include the shared webhook headers.

Request Body

application/json

Webhook payload.

TypeScript Definitions

Use the request body type in TypeScript.

body*DiagnosticOrder
id*string (uuid)
diagnosticTests?array<string (iri-reference)>

IRIs of the diagnostic tests that belong to this order.

createdAt*string (date-time)

Timestamp when the order was created.

fulfilledAt?string | null

Timestamp when the outbound shipment was handed over.

shipmentTracking?ShipmentTracking | null

Tracking details for the outbound shipment, when available.

provider*string

Allowed values: "DHL", "Swiss Post", "OTHER"

createdAt*string (date-time)

Timestamp when the shipment was created.

updatedAt*string (date-time)

Timestamp when the shipment was last updated.

trackingCode?string | null
url?string (url)
shipmentStatus?string | null

Normalized shipment status for informational purposes only.

Allowed values: "confirmed", "in_transit", "out_for_delivery", "delivered", "failure", "undeliverable", "returned_to_sender", "available_for_collection", null

providerStatus?string | null

Shipment status from the provider please note some Providers are not 100% reliable and will occasionally deliver shipments without status updates.

rawProviderHistory?array | null

Raw shipment history from the provider.

shippingAddress?FullAddressInput | null

Shipping address stored for the order.

address1*string
address2?string | null
zip*string
city*string
countryCode?string
firstName*string
lastName*string
id?string (uuid)
phone?string | null
company?string | null
name?string | null
metadata?array | null

Optional partner-defined metadata. Up to 10 entries are supported and values must be JSON primitive values (string, number, or boolean).

Response Body

Example Requests

POST/diagnostic_orders/fulfilled