Skip to main content
Equipment records tell wede what a team can bring to an incident. Each record is an item of your organisation’s equipment and qualifications list (GET /v1/catalog/equipment, see Event types), the same list the event types of your catalog use to say what resolves them. Only equipment with status operational counts when wede ranks teams against the required_equipment of the event type; missing items lower the score and never exclude the team.

Authentication

Session token (Authorization: Bearer <token>).
The integration API key (x-wede-api-key) has no teams:* permission. Calls with an API key return 403 forbidden.

The equipment object

string
Equipment record UUID.
string
Team UUID.
string
Your tenant.
string
Display name, for example Defibrillator.
string
Code of the item in your equipment list, lowercase, unique within the team, for example defibrillator.
integer
Number of units, greater than 0.
string
operational, maintenance or out_of_service.
string | null
Free text.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.

List equipment

Returns { "data": [ ... ] } with the team’s equipment ordered by name.

Add equipment

string
required
Code of an active item of your equipment list (GET /v1/catalog/equipment). Lowercase letters, digits and _. An unknown code returns 422 unknown_equipment.
string
Label for this team’s item, for example VMER 1. Defaults to the item’s name in your list.
integer
default:"1"
Greater than 0.
string
default:"operational"
operational, maintenance or out_of_service.
string
Free text.
If the team already has equipment with this code, wede replaces its name, quantity, status and notes with the values you send (an omitted quantity, status or notes goes back to 1, operational or null).
Response 201
wede sends the team.equipment.added webhook with { team_id, code, name }.

Update equipment

Send any of quantity, status and notes. Omitted fields keep their value.
Returns 200 with the equipment object. wede sends the team.equipment.updated webhook with { team_id, equipment_id, status, quantity } (null for a field you did not send).

Remove equipment

Returns 204 with no body. wede sends the team.equipment.removed webhook with { team_id, equipment_id }.

Errors