> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.benchling.com/in-vivo/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.benchling.com/in-vivo/_mcp/server. # Planned animal deleted POST Sent once per planned animal deleted. The payload is the planned animal as it was before deletion. Reference: https://docs.benchling.com/in-vivo/webhooks/webhook-planned-animal-deleted ## Request ### Headers - `Signature` (string, required) — Lowercase hex-encoded HMAC-SHA256 of the raw request body, keyed with your webhook's signing secret. Compute it over the bytes exactly as received, before parsing, and compare in constant time. ### Payload - `id` (string, required) — Unique identifier for a webhook event. A retried delivery carries the same identifier, so use it to discard duplicates. - `event` (enum, required) — The event that occurred. - Allowed values: `planned_animal.created`, `planned_animal.updated`, `planned_animal.deleted` - `version` (enum, required) — A released version of the public API. Each OAuth client is registered against one version, which determines the response shape it receives. - Allowed values: `2022-12-14` - `created_at` (datetime, required) — UTC timestamp with microsecond precision, always suffixed with `Z`, in the form `yyyy-MM-ddTHH:mm:ss.SSSSSSZ`. - `payload` (AnimalDefinitionV1, required) — A planned animal on a study: the animal a study expects to enrol, with the strain, sex and group it is planned for, and the animal assigned to it once one is. - `client_id` (string, optional) — 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. ## Types ### AnimalDefinitionV1 A planned animal on a study: the animal a study expects to enrol, with the strain, sex and group it is planned for, and the animal assigned to it once one is. - `id` (string, required) — Unique identifier for a planned animal on a study. - `planned_id` (string, required) — The identifier your team gave the planned animal within its study. - `strain` (string, required, nullable) — The strain the animal is planned to be. - `species` (string, required, nullable) — The species of the planned strain. Null when no strain is planned. - `sex` (enum, required, nullable) — The sex the animal is planned to be. - Allowed values: `m`, `f`, `u` - `metadata` (map from string to any, required, nullable) — The metadata assigned to the planned animal. Null when none is assigned. - `animal_id` (string, required, nullable) — The animal assigned to the plan. Null until one is assigned. - `study` (StudyNestedV1, required, nullable) — The study the animal is planned on. - `study_group` (StudyGroupNestedV1, required, nullable) — The group the animal is planned for. Null when no group is planned. - `created_at` (datetime, required) — UTC timestamp with microsecond precision, always suffixed with `Z`, in the form `yyyy-MM-ddTHH:mm:ss.SSSSSSZ`. - `updated_at` (datetime, required) — UTC timestamp with microsecond precision, always suffixed with `Z`, in the form `yyyy-MM-ddTHH:mm:ss.SSSSSSZ`. ### StudyNestedV1 The study a record belongs to, as embedded in animals, dosages, measurements, observations and samples. Carries the same attributes as a study retrieved directly, except that the project is given as an identifier rather than an embedded object. - `id` (string, required) — Unique identifier for a study. - `project_id` (string, required, nullable) — The project of the study. Null when the study is not in a project. - `name` (string, required) — The name of the study. - `code` (string, required, nullable) — The code of the study. - `study_code_id` (string, required, nullable) — The unique identifier of the study code template. - `type` (enum, required) — Whether the study is run in-house or by an external partner. The `all` value accepted by some filters is not a valid study type and is never returned. - Allowed values: `internal`, `external` - `status` (enum, required) — Review status of a study. - Allowed values: `awaiting_approval`, `in_progress`, `rejected` - `description` (string, required, nullable) — The description of the study. - `timezone` (string, required, nullable) — The timezone of the study, as an IANA timezone identifier. - `metadata` (map from string to any, required, nullable) — The metadata associated to the study. - `author` (StudyAuthorUserV1, required, nullable) — The author of the study. - `owner` (StudyAuthorUserV1, required, nullable) — The owner of the study. - `started_on` (date, required) — Calendar date with no time or offset component, in ISO-8601 form. - `tracking_day_base` (integer, required, nullable) — The day number assigned to the study's start date, from which all subsequent tracking days are counted. - `completed_at` (datetime, required, nullable) — The completed timestamp of the study. - `canceled_at` (datetime, required, nullable) — The canceled timestamp of the study. - `created_at` (datetime, required) — UTC timestamp with microsecond precision, always suffixed with `Z`, in the form `yyyy-MM-ddTHH:mm:ss.SSSSSSZ`. - `updated_at` (datetime, required) — UTC timestamp with microsecond precision, always suffixed with `Z`, in the form `yyyy-MM-ddTHH:mm:ss.SSSSSSZ`. ### StudyGroupNestedV1 The treatment group an animal is assigned to within a study, as embedded in the animal. The study is given as an identifier rather than an object to keep the animal response from nesting the same study twice. - `id` (string, required) — Unique identifier for a study group. - `study_id` (string, required) — Unique identifier for a study. - `name` (string, required) — The name of the study group. - `no` (integer, required, nullable) — The position of the group in the study's group ordering. - `color` (string, required, nullable) — The colour used to represent the group in the interface. - `max_animals` (integer, required, nullable) — The number of animals the group can hold. Assigning an animal to a group already at this capacity is rejected. Null when the group is uncapped. - `control` (boolean, required) — Whether the group is the study's control group. - `metadata` (map from string to any, required, nullable) — The metadata associated to the study group. - `created_at` (datetime, required) — UTC timestamp with microsecond precision, always suffixed with `Z`, in the form `yyyy-MM-ddTHH:mm:ss.SSSSSSZ`. - `updated_at` (datetime, required) — UTC timestamp with microsecond precision, always suffixed with `Z`, in the form `yyyy-MM-ddTHH:mm:ss.SSSSSSZ`. ### StudyAuthorUserV1 A user referenced as the author or owner of a study. - `id` (string, required) — Unique identifier for a user. - `name` (string, required) — The name of the user. - `email` (string, required) — The email address of the user. - `timezone` (string, required) — The timezone of the user. Defaults to `UTC` when the user has none set.