Probatix Documentation
Probatix Webhooks v1

Specimen collection kit fulfilled

Sent when a specimen collection kit is fulfilled.

Sent when a specimen collection kit is fulfilled.

All webhook requests include the shared webhook headers.

Request Body

application/json

Webhook payload.

TypeScript Definitions

Use the request body type in TypeScript.

body*SpecimenCollectionKit
id*string (uuid)
product*string (iri-reference)

IRI of the specimen collection kit product this kit belongs to.

fulfillmentData?object | null

Optional fulfillment-specific data. Values must be JSON primitive values.

udi?UniqueDeviceIdentifierDetail | null
normalizedText*string
deviceIdentifier*string
lotNumber?string | null
serialNumber?string | null
additionalProductIdentifier?string | null
expirationDate?string | null
manufactureDate?string | null
createdAt*string (date-time)
fulfilledAt?string | null
outboundShipment?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.

returnShipment?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.

Response Body

Example Requests

POST/sck_kits/fulfilled

Test result evaluated Webhook

Sent when evaluation of a test result is complete.

Specimen collection kit order created Webhook

Sent when a specimen collection kit order is created.