Skip to content

Create a weather reading

Workforce module

POST/weather-readingsweatherReadings.create

A weather reading on site, in the hazard's unit. Creates a weather reading. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability safety.incident.write.
  • OAuth scopes: safety.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: WeatherReadingCreate

weatherReadings.create: WeatherReadingCreate
FieldTypeRequiredDescription
project_idstring (uuid)YesIdentifier of the project.
hazard"Wind" | "Lightning" | "Heat"YesHazard.
reading_valuenumberYesReading.Constraints: range 0 to 200
observed_atstring (date-time)YesWhen it was observed.
{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "hazard": "Wind",
  "reading_value": 33,
  "observed_at": "2026-10-08T14:30:00Z"
}

Response 201: WeatherReading

weatherReadings.create: WeatherReading
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the weather reading.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
project_idstring (uuid)YesIdentifier of the project.
hazard"Wind" | "Lightning" | "Heat"YesHazard.
reading_valuenumberYesReading.Constraints: range 0 to 200
observed_atstring (date-time)YesWhen it was observed.
recorded_by_membership_idstring (uuid) | nullYesIdentifier of the member who recorded it.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "hazard": "Wind",
  "reading_value": 33,
  "observed_at": "2026-10-08T14:30:00Z",
  "recorded_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/weather-readings" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","hazard":"Wind","reading_value":33,"observed_at":"2026-10-08T14:30:00Z"}'
const { data } = await xos.weatherReadings.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "hazard": "Wind",
    "reading_value": 33,
    "observed_at": "2026-10-08T14:30:00Z"
  });
response = xos.weather_readings.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "hazard": "Wind", "reading_value": 33, "observed_at": "2026-10-08T14:30:00Z"})
xos weather-readings create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","hazard":"Wind","reading_value":33,"observed_at":"2026-10-08T14:30:00Z"}'