Webhooks
Subscribe to receive push notifications with Kit or Lab Order status
Method : POST
Endpoint : define by client
A client needs to provide an endpoint(url) for Molecular to set up where to send to notification to, the endpoint can use basic authentication for the request, Username & Password would be the user & token that are provided by Molecular(same user & token in Authentication).
Content Type : application/json
Object Notes
Variable | Expected Type | Notes |
---|---|---|
order_number |
string |
|
accession_number |
string |
|
type |
string |
notification type |
outbound |
string |
outbound USPS/FedEx tracking number |
inbound |
string |
return USPS/FedEx tracking number |
shipped_datetime |
string |
|
kit_reg_code |
string |
|
oraquick_lot_exp |
string |
for OraQuick kit use |
received_datetime |
string |
|
rejected_datetime |
string |
|
rejected_reason |
string |
|
recoverable |
boolean |
can be placed back to production or not |
report_sent_datetime |
string |
Kit shipped notification example
{ "order_number": "123123", "accession_number": "M000031828", "type": "kit_shipped", "ship_info": { "outbound": "1111497584974311111", "inbound": "1111498798437922222", "shipped_datetime": "2018-01-11T19:53:08.885569Z", "kit_reg_code": null, "oraquick_lot_exp": "" }, "rcvd_info": null, "rej_info": null, "report_ready_info": null }
Kit received example
{ "order_number": "123123", "accession_number": "M000057021", "type": "kit_received", "ship_info": null, "rcvd_info": { "received_datetime": "2018-01-11T19:53:08.885569Z" }, "rej_info": null, "report_ready_info": null }
Kit rejected example
{ "order_number": "123123", "accession_number": "F000057212", "type": "kit_rejected", "ship_info": null, "rcvd_info": null, "rej_info": { "rejected_datetime": "2018-01-11T19:53:08.885569Z", "rejected_reason": "No patient identifiers listed on the sample container / envelope.", "recoverable": true }, "report_ready_info": null }
Report ready example
{ "order_number": "123123", "accession_number": "M000057021", "type": "report_ready", "ship_info": null, "rcvd_info": null, "rej_info": null, "report_ready_info": { "report_sent_datetime": "2018-01-11T19:53:08.885569Z" } }