Webhook Results Ready

When a user's scan results are ready to pull, BodySpec sends a POST request with this payload to your registered webhook URL. The event fires once the underlying analysis has landed in BodySpec's database, so the results are queryable by the time you receive it.

Delivery is at-least-once: if a scan is re-analyzed, another results_ready is sent for the same result. Treat repeats as expected and deduplicate on data.result_id. event_id is unique per delivery and differs across repeats, so do not dedupe on it.

postWebhookresults_ready

Payload

event_type'results_ready' required

Type of event (always 'results_ready' for this payload)

event_idstring required

Unique identifier for this event

partner_idstring required

Partner ID this event is for

Example payload

{
  "data": {
    "appt_id": "d7ecde6e9518008607e0e1e3b4b960d9",
    "result_id": "d7ecde6e9518008607e0e1e3b4b960d9",
    "service_id": "8d0e0a1f561f4ec69dbca50ea14336d",
    "start_time": "2024-03-15T10:30:00-07:00",
    "user_id": "a5950beea2a7487fb79cfdbeb77fa555"
  },
  "event_id": "550e8400e29b41d4a716446655440000",
  "event_type": "results_ready",
  "partner_id": "pk_acme"
}

Response

Successful Response

unknown required

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.