Equipment events

Scopes: write:equipment_events to record, read:equipment to look equipment up. Endpoints: Record an equipment event, List equipment, List equipment events.

Equipment that can call a webhook, or a small script beside it, can keep xPlant's equipment records current without anyone typing them in. You need the equipment's id: find it with List equipment.

Two kinds of eventCopy Anchor Link

The two kinds answer different questions, and xPlant keeps them apart:

• Usage (kind: "used") answers how hard has this been worked? It records use against a subject, such as the batch or run it was used for.
• Maintenance (kind: "calibration" or "preventive_maintenance") answers is it fit to use? It carries an outcome: pass, pass_after_adjustment, out_of_tolerance, fail or not_performed. Calibration and maintenance records are part of equipment calibration, which not every plan includes.

Recording an event doesn't move the equipment's calibration or maintenance due dates; those follow the lab's schedules in xPlant.

Record a calibrationCopy Anchor Link

curl -X POST "https://app.xplantpro.com/api/v1/equipment/$EQUIPMENT_ID/events" \
  -H "Authorization: Bearer $XPLANT_API_KEY" \
  -H "Idempotency-Key: ph-meter-2-cal-2026-09-25" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "calibration",
    "outcome": "pass",
    "performed_at": "2026-09-25T07:30:00Z",
    "result_summary": "Two-point calibration, pH 4.01 and 7.00"
  }'

Maintenance fields: outcome, performed_at, performed_by_name, result_summary, notes. List equipment events reads the history back.

Record a useCopy Anchor Link

curl -X POST "https://app.xplantpro.com/api/v1/equipment/$EQUIPMENT_ID/events" \
  -H "Authorization: Bearer $XPLANT_API_KEY" \
  -H "Idempotency-Key: autoclave-2-cycle-4411" \
  -H "Content-Type: application/json" \
  -d '{"kind": "used", "subject_type": "media_batch", "subject_id": "'"$MEDIA_BATCH_ID"'", "notes": "Media sterilisation cycle"}'

Usage fields: subject_type, subject_id, subject_label, used_at, notes. subject_type is one of sop_log, media_batch, plant_transfer, explant_transfer or contamination_log: what the equipment was used for.

Good to knowCopy Anchor Link

• Events are append-only. A correction is another event.
• Equipment in another workspace answers 404, the same as equipment that doesn't exist.
• The endpoint honours Idempotency-Key. Build it from something the equipment already numbers, like a cycle count or a calibration date, so a webhook that fires twice records once.