Probatix Documentation
Probatix Webhooks v1

Diagnostic order created

Sent when a diagnostic order is created.

Sent when a diagnostic order is created.

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
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
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/created

Webhook headers

Headers included with every Probatix webhook delivery.

Diagnostic test replaced Webhook

Sent when a diagnostic test has been replaced.