Create a weather threshold
Workforce module
POST/weather-thresholdsweatherThresholds.create
A weather action threshold of a project: one value per hazard and level, with its emergency plan source. Creates a weather threshold. 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.emergency_code.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: WeatherThresholdCreate
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Identifier of the project. |
| hazard | "Wind" | "Lightning" | "Heat" | Yes | Hazard. |
| alert_level | "Monitor" | "Restrict" | "Evacuate" | Yes | Level. |
| threshold_value | number | Yes | Value that triggers the level.Constraints: range 0 to 200 |
| unit | "mph" | "mi" | "F" | Yes | Unit: mph for wind, mi for lightning distance, F for heat index. |
| comparison | "At or Above" | "At or Below" | Yes | At or Above for wind and heat, At or Below for lightning. |
| source_note | string | Yes | Where the value comes from.Constraints: length 1 to 300 |
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"hazard": "Wind",
"alert_level": "Monitor",
"threshold_value": 30,
"unit": "mph",
"comparison": "At or Above",
"source_note": "Emergency plan 4.2"
}Response 201: WeatherThreshold
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the weather threshold. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| hazard | "Wind" | "Lightning" | "Heat" | Yes | Hazard. |
| alert_level | "Monitor" | "Restrict" | "Evacuate" | Yes | Level. |
| threshold_value | number | Yes | Value that triggers the level.Constraints: range 0 to 200 |
| unit | "mph" | "mi" | "F" | Yes | Unit: mph for wind, mi for lightning distance, F for heat index. |
| comparison | "At or Above" | "At or Below" | Yes | At or Above for wind and heat, At or Below for lightning. |
| source_note | string | Yes | Where the value comes from.Constraints: length 1 to 300 |
{
"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",
"alert_level": "Monitor",
"threshold_value": 30,
"unit": "mph",
"comparison": "At or Above",
"source_note": "Emergency plan 4.2"
}Code samples
curl -X POST "$XOS_BASE_URL/weather-thresholds" \
-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","alert_level":"Monitor","threshold_value":30,"unit":"mph","comparison":"At or Above","source_note":"Emergency plan 4.2"}'const { data } = await xos.weatherThresholds.create({
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"hazard": "Wind",
"alert_level": "Monitor",
"threshold_value": 30,
"unit": "mph",
"comparison": "At or Above",
"source_note": "Emergency plan 4.2"
});response = xos.weather_thresholds.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "hazard": "Wind", "alert_level": "Monitor", "threshold_value": 30, "unit": "mph", "comparison": "At or Above", "source_note": "Emergency plan 4.2"})xos weather-thresholds create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","hazard":"Wind","alert_level":"Monitor","threshold_value":30,"unit":"mph","comparison":"At or Above","source_note":"Emergency plan 4.2"}'