Basics
Webhooks allow you to be notified on your server when certain events happen, rather than having to poll our API all the time. For more info on webhooks in general see
Coming soon
Wehbooks are not yet available for public use.
The objects that cause webhooks to happen are:
Orders
When a customer order moves through the states (dispatched, delivered etc) these fire webhooks.
Event | Object | Description |
|---|---|---|
order.dispatched | Order | Order has been dispatched |
order.out_for_delivery | Order | Order is out for delivery (Note: this is subject to shipping method) |
order.received | Order | Order has been received by the customer (Note: this is subject to shipping method) |
order.created | Order | Order has been created |
Tests
When a test moves through the various states this fires webhooks (registered, arrived at lab, resulted etc)
Event | Object | Description |
|---|---|---|
test.registered | Test | Test has been registered |
test.lab_accessioned | Test | Test has been received at the lab (accessioned) |
test.processed | Test | Test has results |
test.validation_success | Test | Test validation success |
test.validation_fail | Test | Test validation fail |
test.ordered | Test | Test ordered |
Registrations
Event | Object | Description |
|---|---|---|
registration.success | Registration | Registration success |
Updated 1 day ago