Sample definition updated

Payload

{
  "id": "whe_7E5H2v4X0hfhqLVmZg9HYZ",
  "event": "study.sample_definition.created",
  "version": "2022-12-14",
  "created_at": "2026-09-18T14:03:22.123456Z",
  "payload": {
    "id": "sdf_7yQ2mKpNvR8xTw4YbCdFgT",
    "sample_type": {
      "team_glossary_id": "tgy_6vQ3mKpNvR7zTw8YbCdFgW",
      "title": "Blood Sample"
    },
    "name": "Whole Blood - Baseline",
    "timepoints": [
      "PT4H"
    ],
    "details": [
      {
        "key": "volume",
        "value": "5",
        "unit": "ml"
      }
    ],
    "metadata": {
      "cohort_size": 24,
      "species": "Mus musculus"
    },
    "study": {
      "id": "sdy_3vQ8kZpLmN2xRt7YwBcDfG",
      "project_id": "pjt_9kLmNpQrStUvWxYzAbCdEf",
      "name": "string",
      "code": "string",
      "study_code_id": "sdc_7hJ4nQrXsT9wYzAbCdEfGh",
      "type": "internal",
      "status": "in_progress",
      "description": "string",
      "timezone": "America/Los_Angeles",
      "metadata": {
        "cohort_size": 24,
        "species": "Mus musculus"
      },
      "author": {
        "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
        "name": "string",
        "email": "string",
        "timezone": "string"
      },
      "owner": {
        "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
        "name": "string",
        "email": "string",
        "timezone": "string"
      },
      "started_on": "2026-09-18",
      "tracking_day_base": 1,
      "completed_at": "2026-09-18T14:03:22.123456Z",
      "canceled_at": "2026-09-18T14:03:22.123456Z",
      "created_at": "2026-09-18T14:03:22.123456Z",
      "updated_at": "2026-09-18T14:03:22.123456Z"
    },
    "created_at": "2026-09-18T14:03:22.123456Z",
    "updated_at": "2026-09-18T14:03:22.123456Z"
  }
}

Sent once per sample definition updated. The payload is the sample definition as updated.

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 planned sample on a study: which sample type to collect, at which timepoints, with which details, and any metadata assigned.

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