> 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. # Animal metadata updated POST Sent when an animal's metadata is updated, alongside `animal.updated`. The payload is the animal as updated. Reference: https://docs.benchling.com/in-vivo/webhooks/webhook-animal-metadata-updated ## 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: `animal.created`, `animal.updated`, `animal.deleted`, `animal.metadata.updated` - `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` (AnimalV1, required) — An animal in your colony. Retrieve it to see its identifiers, strain and species, the cage it is housed in, the study and treatment group it is enrolled on, its termination details, and any metadata assigned. An animal need not belong to a study. - `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 ### AnimalV1 An animal in your colony. Retrieve it to see its identifiers, strain and species, the cage it is housed in, the study and treatment group it is enrolled on, its termination details, and any metadata assigned. An animal need not belong to a study. - `id` (string, required) — Unique identifier for an animal. - `name` (string, required) — The name of the animal. - `number` (integer, required) — The position of the animal within its cage. - `catalog` (string, required, nullable) — The catalog number of the animal. - `species` (string, required, nullable) — The species of the animal, derived from its strain. Null when the animal has no strain assigned. - `strain` (string, required, nullable) — The strain of the animal. - `sex` (enum, required, nullable) — The sex of the animal. - Allowed values: `m`, `f`, `u` - `dob` (date, required, nullable) — The date of birth of the animal. - `donor` (string, required, nullable) — The donor identifier of the animal. - `ear` (string, required, nullable) — The ear marking identifying the animal. - `tag` (string, required, nullable) — The tag identifying the animal. - `tail` (string, required, nullable) — The tail marking identifying the animal. - `study` (StudyNestedV1, required, nullable) — The study the animal is enrolled on. Null when it is not on a study. - `study_group` (StudyGroupNestedV1, required, nullable) — The treatment group the animal is assigned to. Null when it is not on a study, or is on one but not yet grouped. - `cage` (CageNestedV1, required, nullable) — The cage the animal is housed in. - `tracking_date` (date, required, nullable) — The date from which the animal's tracking days are counted. - `disease_induction_date` (date, required, nullable) — The date the animal had a disease induced. - `disease_survivor` (boolean, required, nullable) — Whether the animal survived the induced disease. - `terminated_at` (date, required, nullable) — The date the animal was terminated. Null while the animal is alive. A terminated animal cannot be moved between cages or study groups. - `terminated_by` (StudyAuthorUserV1, required, nullable) — The user who recorded the termination. - `terminated_reason` (AnimalTerminatedReasonV1, required, nullable) — Why the animal was terminated. - `metadata` (map from string to any, required, nullable) — The metadata associated to the animal. - `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`. ### CageNestedV1 The cage an animal is housed in, 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 cage. - `study_id` (string, required, nullable) — The study the cage belongs to. Null for a cage not assigned to a study. - `name` (string, required) — The name of the cage. - `catalog` (string, required, nullable) — The catalog number of the cage. - `metadata` (map from string to any, required, nullable) — The metadata associated to the cage. - `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. ### AnimalTerminatedReasonV1 Why an animal was terminated. The reason is chosen from the shared glossary, or recorded free-form when no glossary entry fits. - `glossary_id` (string, required, nullable) — The glossary entry the reason was chosen from. Null when the reason was recorded free-form. - `title` (string, required, nullable) — The reason for the termination. - `comment` (string, required, nullable) — Any further detail recorded alongside the reason.