Sample created

Payload

{
  "id": "whe_7E5H2v4X0hfhqLVmZg9HYZ",
  "event": "animal.sample.created",
  "version": "2022-12-14",
  "created_at": "2026-09-18T14:03:22.123456Z",
  "payload": {
    "id": "spl_3v53xvXQHlnAlOmJB5TJQA",
    "sample_id": "S596602244",
    "sample_definition_id": "sdf_2ndB1hOdyfVm9zpOzl8Q7V",
    "type": "Blood",
    "label": "BLOOD",
    "status": "collected",
    "timepoint": "PT15M",
    "collected_at": "2026-09-10T09:27:59.353342Z",
    "details": [
      {
        "key": "volume",
        "value": "5",
        "unit": "ml"
      }
    ],
    "comments": "A blood sample",
    "metadata": {
      "sample-internal-id": "SMPL-1234"
    },
    "study": {
      "id": "sdy_6y9Wop1uArRjD93UiQ5qFy",
      "project_id": "pjt_7IrvD7jMtAGvBl4AQUUr3g",
      "name": "Benchling In Vivo",
      "code": "CD-26-445",
      "study_code_id": "sdc_n6vkWmmHoACZ15pTxztHk",
      "type": "internal",
      "status": "in_progress",
      "description": "Efficacy study in a xenograft model.",
      "timezone": "America/Los_Angeles",
      "metadata": {
        "study-internal-id": "STUDY-1234"
      },
      "author": {
        "id": "usr_72aeLmlraBB7Ekzu2zTsMW",
        "name": "Jo Harper",
        "email": "jo.harper@example.com",
        "timezone": "UTC"
      },
      "owner": {
        "id": "usr_5TSgutt2ZHPnKOdYbaNlRo",
        "name": "Sam Ellis",
        "email": "sam.ellis@example.com",
        "timezone": "UTC"
      },
      "started_on": "2026-09-10",
      "tracking_day_base": 0,
      "completed_at": null,
      "canceled_at": null,
      "created_at": "2026-09-10T07:27:34.132511Z",
      "updated_at": "2026-09-10T07:27:34.132511Z"
    },
    "animal": {
      "id": "aml_71H39zdfOc89pNIutQSI22",
      "name": "Animal 1",
      "number": 1,
      "catalog": "A0000001",
      "species": "Mus musculus",
      "strain": "C57BL/6J",
      "sex": "m",
      "dob": "2026-09-09",
      "donor": null,
      "ear": "2R",
      "tag": "T-0041",
      "tail": "1",
      "cage_id": "cge_6uFo3TUYezxtFuImb9kk8K",
      "study_id": "sdy_6y9Wop1uArRjD93UiQ5qFy",
      "study_group_id": "grp_1OEdawZKhmLCf88R4AnCZm",
      "tracking_date": "2026-09-10",
      "disease_induction_date": "2026-09-10",
      "disease_survivor": false,
      "terminated_at": null,
      "terminated_by": null,
      "terminated_reason": null,
      "metadata": {
        "animal-internal-id": "ANIMAL-1234"
      },
      "created_at": "2026-09-10T07:27:10.785238Z",
      "updated_at": "2026-09-10T07:27:10.785238Z"
    },
    "user": {
      "id": "usr_1aK0d7qAQqU5vqrEXkU6oU",
      "name": "Robin Vance",
      "email": "robin.vance@example.com",
      "timezone": "America/Los_Angeles",
      "status": "active",
      "metadata": {
        "user-internal-id": "USER-1234"
      },
      "created_at": "2026-09-10T07:26:30.018301Z",
      "updated_at": "2026-09-10T07:26:30.018301Z"
    },
    "created_at": "2026-09-10T07:27:59.354616Z",
    "updated_at": "2026-09-10T07:27:59.354616Z"
  }
}

Sent once per sample collected from an animal. The payload is the sample.

Payload

The payload of this webhook request is an object.

idstringRequiredformat: "^whe_[a-zA-Z0-9]{10,22}$"

Unique identifier for a webhook event. A retried delivery carries the same identifier, so use it to discard duplicates.

eventenumRequired

The event that occurred.

Allowed values:

versionenumRequired

A released version of the public API. Each OAuth client is registered against one version, which determines the response shape it receives.

Allowed values:

created_atdatetimeRequired

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

payloadobjectRequired

A specimen collected from an animal, or planned for collection. A sample is described by its sample definition, which determines its type, the details recorded against it, and the timepoint it is due at relative to the study schedule.

client_idstringOptionalformat: "uuid"

The OAuth client whose API request caused the event. Omitted when the event did not originate from an API request, and on events that never carry it.

Response

2XX

Any 2xx status acknowledges the delivery, which is then not retried. The response body is ignored.

Headers

Payload

Response