Treatment created

Payload

{
  "id": "whe_7E5H2v4X0hfhqLVmZg9HYZ",
  "event": "study.treatment.created",
  "version": "2022-12-14",
  "created_at": "2026-09-18T14:03:22.123456Z",
  "payload": {
    "id": "tmt_3zQ9mKpNvR5xTw6YbCdFgR",
    "type": "concentration",
    "name": "string",
    "label": "Test Treatment Label",
    "external_entity_id": "string",
    "dose": {
      "unit": "mg/kg",
      "value": "3.18",
      "display_unit": "mg/kg",
      "display_value": "3.18"
    },
    "dose_volume": {
      "unit": "ml/kg",
      "value": "15.88",
      "display_unit": "ml/kg",
      "display_value": "15.88"
    },
    "stock": {
      "unit": "mg/ml",
      "value": "22.29",
      "display_unit": "mg/ml",
      "display_value": "22.29"
    },
    "volume": {
      "unit": "µL",
      "value": "36.77",
      "display_unit": "µL",
      "display_value": "36.77"
    },
    "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"
    },
    "study_group": {
      "id": "grp_9nT4kZpMvR2xQw8YbCdFgJ",
      "study_id": "sdy_3vQ8kZpLmN2xRt7YwBcDfG",
      "name": "string",
      "no": 1,
      "color": "string",
      "max_animals": 1,
      "control": true,
      "metadata": {
        "cohort_size": 24,
        "species": "Mus musculus"
      },
      "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 treatment created on a study. The payload is the treatment.

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 treatment assigned to a study group. You can retrieve it to see the method, compound name, label, prescribed quantities, linked study and study group, 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