{"openapi":"3.1.0","info":{"title":"Orbitify operations API for connected systems","version":"2026-10-24","description":"Another system works with a company in Orbitify through a connection: an account of its own with roles as a person has them, and keys made in Settings > Connected systems. Send a key as `Authorization: Bearer <key>` and an `Idempotency-Key` header with every change: sent again with the same key, a change is answered from the first time and never made twice.\n\nEvery change is an action, checked as a person's would be (roles, plan, approvals, the flow's rules) and kept in history under the connection's name. Send `dryRun: true` to see what it would do. A refusal says why in words (`message`).\n\nIds: ours (uuid) or the other system's, written `system:id` (`erp:WO-55120`), wherever an id is taken. A create may carry `outsideId`; sent again with it, it answers with the record made before (`summary.existing`).\n\nWhat happens is sent as events: to an https address (webhooks, signed as Standard Webhooks 1.0) and in the event list (`GET /api/ops/events`), oldest first, paged by `seq`. An event says what changed and where to look, never the record: read the record for its values. Order is not guaranteed: drop an event whose `version` is older than one already seen.\n\nLimits: 120 calls a minute per key, 600 per company. A connection that suddenly changes far more than usual is paused until an administrator resumes it.\n\nTry it first in a test company: a company's administrators make one in Settings > Connected systems, with the company's kinds, fields, flows, roles and teams (and its locations and assets when asked), and no real work. Make the connection and its key there; `GET /api/ops/test-company` says whether a key works in one (`testOf`). A key works only in the company it was made in.\n\nLive data from a site (a gateway, a trend log) is sent with a key of its own, which opens `POST /api/ops/live/ingest` only.\n\nVersions: this API is version 2026-10-24 and changes only by adding: new actions, parameters, fields, values and event kinds. Ignore fields and values you do not know. Send `Orbitify-Version: 2026-10-24` to name the version you were written for; every answer names the version it followed. A change that cannot be made by adding comes as a new version, announced at least 6 months before the older one ends. An action on its way out is marked deprecated here, and calls to it answer with the `Deprecation` and `Sunset` headers and a `Link` to what to do."},"servers":[{"url":"https://dashboard.orbitify.ai"}],"security":[{"connectionKey":[]}],"tags":[{"name":"request","description":"Requests"},{"name":"work_order","description":"Work orders"},{"name":"task","description":"Tasks"},{"name":"asset","description":"Assets and readings"},{"name":"live","description":"Live data from sites"},{"name":"location","description":"Locations"},{"name":"stock","description":"Parts, suppliers and stock"},{"name":"events","description":"Events"},{"name":"reads","description":"Reads"}],"paths":{"/api/ops/actions/asset.create":{"post":{"operationId":"asset_create","tags":["asset"],"summary":"Add asset","description":"Add an asset (a piece of equipment, infrastructure, a vehicle or a tool) to the register at a location or inside another asset. Use it when something new is installed or found that is not on the register; asset.register also records its warranty, value, spare parts and maintenance plan in one go. A serial number another asset has is refused. Coming from another system, send outsideId with that system's asset id so a repeat makes nothing twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"params":{"type":"object","properties":{"name":{"type":"string"},"attrs":{"type":"object"},"builtOn":{"type":"string","format":"date","description":"when it was built"},"classKey":{"type":"string","description":"The kind of asset, a key from GET /api/ops/registry (classes of kind asset)"},"code":{"type":"string"},"defaultWorkKindKey":{"type":"string","description":"the kind of work a work order about it is when nobody says"},"groupId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"its asset group (V317"},"installedOn":{"type":"string","format":"date"},"investedOn":{"type":"string","format":"date","description":"when it was paid for"},"locationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"manufacturer":{"type":"string"},"model":{"type":"string"},"ownerEntityId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"a legal entity in the company's group; null: its place's"},"parentAssetId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"projectId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"serialNumber":{"type":"string"},"yearlyCost":{"type":"number","description":"what keeping it costs a year"},"yearlyCostCurrency":{"type":"string","description":"default: the company's"},"outsideId":{"type":"string","description":"The other system's id for it, system:id; it is then made once"}},"required":["name"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"A pump in a plant room","value":{"params":{"name":"Chilled water pump 3","classKey":"pump","locationId":"9e8d7c6b-0000-4000-8000-000000000014","manufacturer":"Northside Pumps","model":"NB 65-200","serialNumber":"SN-77811"}}},"example2":{"summary":"A pump from another register","value":{"params":{"name":"Chilled water pump 2","classKey":"pump","locationId":"erp:PLANT-1","serialNumber":"SN-77810","outsideId":"erp:EQ-1042"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"asset.create","objectKind":"asset","destructive":false,"planPart":"CORE","needsTarget":false,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/asset.move":{"post":{"operationId":"asset_move","tags":["asset"],"summary":"Move asset","description":"Move an asset to another location or inside another asset; its history keeps where it was and why (moved, removed, returned, swapped under warranty). To put a spare in an asset's place, asset.replace.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"expectedVersion":{"type":"integer"},"locationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"note":{"type":"string"},"parentAssetId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"reason":{"type":"string","enum":["MOVED","REMOVED","RETURNED","WARRANTY_SWAP"],"description":"MOVED | REMOVED | RETURNED | WARRANTY_SWAP (why, for its history)"}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"Out to the workshop","value":{"target":"erp:EQ-1042","params":{"locationId":"erp:WORKSHOP","reason":"REMOVED","note":"Sent for repair"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"asset.move","objectKind":"asset","destructive":false,"planPart":"CORE","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/asset.update":{"post":{"operationId":"asset_update","tags":["asset"],"summary":"Edit asset","description":"Change what an asset's record says: name, code, kind, make, model, serial number, dates, fields, group. Not where it is (asset.move) nor who looks after it (asset.set_care).","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"attrs":{"type":"object"},"builtOn":{"type":"string","format":"date"},"classKey":{"type":"string"},"code":{"type":"string"},"defaultWorkKindKey":{"type":"string"},"expectedVersion":{"type":"integer"},"groupId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"its asset group (V317); null: none"},"installedOn":{"type":"string","format":"date"},"investedOn":{"type":"string","format":"date"},"manufacturer":{"type":"string"},"model":{"type":"string"},"name":{"type":"string"},"ownerEntityId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"a legal entity in the company's group; null: its place's"},"serialNumber":{"type":"string"},"yearlyCost":{"type":"number"},"yearlyCostCurrency":{"type":"string"}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"Its serial number","value":{"target":"erp:EQ-1042","params":{"serialNumber":"SN-77810-B"}}},"example2":{"summary":"Its make and model","value":{"targetId":"6a1b3c5d-0000-4000-8000-000000000013","params":{"manufacturer":"Northside Pumps","model":"NB 65-250"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"asset.update","objectKind":"asset","destructive":false,"planPart":"CORE","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/cost.add":{"post":{"operationId":"cost_add","tags":["work_order"],"summary":"Add a cost to a work order","description":"Add a cost to a work order (the target): parts, a purchase, a subcontractor, travel, other; in any currency, at the latest rate kept. Parts from the store are charged by issuing them (part.issue), not here.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"},"kind":{"type":"string","enum":["PART","PURCHASE","SUBCONTRACT","TRAVEL","OTHER"],"description":"PART | PURCHASE | SUBCONTRACT | TRAVEL | OTHER"},"currency":{"type":"string","description":"Its currency (ISO 4217); the company's when left out"},"incurredOn":{"type":"string","format":"date"},"rate":{"type":"number","description":"Its rate to the company's currency; the latest kept when left out"},"vendorId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]}},"required":["amount","description","kind"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"A subcontractor's bill","value":{"target":"erp:WO-55120","params":{"kind":"SUBCONTRACT","description":"Crane hire, half a day","amount":450,"currency":"EUR"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"cost.add","objectKind":"job_cost","destructive":false,"planPart":"MONEY","needsTarget":true,"autonomyTier":3,"since":"2026-10-24"}}},"/api/ops/actions/location.create":{"post":{"operationId":"location_create","tags":["location"],"summary":"Create location","description":"Add a location (a building, a floor, a room, an area, a site) inside another, with its kind, code and fields; optionally its pin or outline on the map. Coming from another system, send outsideId with that system's id so a repeat makes nothing twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"params":{"type":"object","properties":{"name":{"type":"string"},"attrs":{"type":"object"},"classKey":{"type":"string"},"clientCode":{"type":"string"},"code":{"type":"string"},"entityId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"a legal entity in the company's group; null: its place's, or the one above"},"outline":{"type":"object","description":"GeoJSON polygon"},"parentId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"The location it is inside (or system:id); a project's own location at the top"},"point":{"type":"array","items":{"type":"number"},"description":"[longitude, latitude]"},"projectId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"outsideId":{"type":"string","description":"The other system's id for it, system:id; it is then made once"}},"required":["name"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"A room","value":{"params":{"name":"Plant room 2","code":"PR-2","parentId":"erp:BLOCK-B","outsideId":"erp:LOC-2201"}}},"example2":{"summary":"A floor in a building","value":{"params":{"name":"Level 3","code":"L3","classKey":"floor","parentId":"9e8d7c6b-0000-4000-8000-000000000014"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"location.create","objectKind":"location","destructive":false,"planPart":"CORE","needsTarget":false,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/location.update":{"post":{"operationId":"location_update","tags":["location"],"summary":"Update location","description":"Change what a location's record says: name, code, kind, fields. A project's own location is renamed with the project. Its client is set by location.set_client; a project's stage and settings by workspace.configure.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"attrs":{"type":"object"},"classKey":{"type":"string"},"code":{"type":"string"},"costCentreId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"entityId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"a legal entity in the company's group; null: its place's, or the one above"},"name":{"type":"string"},"status":{"type":"string"}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"Its code","value":{"target":"erp:LOC-2201","params":{"code":"B-PR-2"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"location.update","objectKind":"location","destructive":false,"planPart":"CORE","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/message.add":{"post":{"operationId":"message_add","tags":["work_order"],"summary":"Write a message","description":"Add a message to a request or a work order (the target): words and files (photos, videos, PDFs uploaded first) the people on it read. Shared messages are seen by the client's people too; a note for the company only is shared false. Use it to tell the people on the work something, or to answer a question on it.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"body":{"type":"string"},"files":{"type":"array","items":{},"description":"of {url, name, contentType, sizeBytes}: photos, videos or PDFs uploaded first"},"objectKind":{"type":"string","enum":["request","work_order"],"description":"request | work_order (request when left out)"},"shared":{"type":"boolean","description":"seen by the client's people; on for a request, off for a work order when left out"}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"A note from the other system","value":{"target":"bms:ALM-88213","params":{"objectKind":"request","body":"The alarm came back at 14:02"}}},"example2":{"summary":"An internal note on a work order","value":{"targetId":"2c7e9a14-0000-4000-8000-000000000012","params":{"objectKind":"work_order","body":"Ask security for the plant room key","shared":false}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"message.add","objectKind":"message","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":1,"since":"2026-10-24"}}},"/api/ops/actions/part.save":{"post":{"operationId":"part_save","tags":["stock"],"summary":"Save a part","description":"Add a spare part or a service to the catalogue, or change one (the target): code, name, unit, usual price, default supplier, whether it is tracked one by one by serial number. Codes are unique. Use it before parts are stocked, reserved or bought.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it changes (ours); left out, it makes a new one. Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"defaultPrice":{"type":"number"},"defaultVendorId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"description":{"type":"string"},"kind":{"type":"string","enum":["PART","SERVICE"],"description":"PART (kept in stores) | SERVICE (bought or charged, never stocked)"},"priceCurrency":{"type":"string"},"tracked":{"type":"boolean","description":"tracked one by one, each with its serial number (repaired and used again"},"unit":{"type":"string"},"outsideId":{"type":"string","description":"Another system's id for what this makes, written system:id; sent again, it answers with the record made before"}},"required":["code","name"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"A filter","value":{"params":{"code":"FLT-600","name":"Bag filter 600x600","unit":"each","defaultPrice":32.5,"priceCurrency":"EUR"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"part.save","objectKind":"part","destructive":false,"planPart":"STOCK","needsTarget":false,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/purchase_order.receive":{"post":{"operationId":"purchase_order_receive","tags":["stock"],"summary":"Receive what came of a purchase order","description":"Receive what came on an issued purchase order (the target): some lines, everything, or what was wrong with it (damaged, wrong item, short, refused). Parts go into stock at the order's price; anything else for a work order becomes its cost. Whoever issued the order is told of problems.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"all":{"type":"boolean"},"lines":{"type":"array","items":{},"description":"of {lineId, quantity, serials: for a part tracked one by one, each one's serial number}"},"note":{"type":"string"},"problems":{"type":"array","items":{},"description":"of {lineId, kind: DAMAGED, WRONG_ITEM, SHORT, REFUSED or OTHER, quantity, note}"},"receivedOn":{"type":"string","format":"date"},"storeId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"Everything came","value":{"target":"erp:PO-7781","params":{"all":true,"receivedOn":"2026-11-03"}}},"example2":{"summary":"One box damaged","value":{"targetId":"a9b8c7d6-0000-4000-8000-000000000020","params":{"lines":[{"lineId":"a9b8c7d6-0000-4000-8000-000000000055","quantity":8}],"problems":[{"lineId":"a9b8c7d6-0000-4000-8000-000000000055","kind":"DAMAGED","quantity":2,"note":"Crushed box"}]}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"purchase_order.receive","objectKind":"purchase_order","destructive":false,"planPart":"STOCK","needsTarget":true,"autonomyTier":3,"since":"2026-10-24"}}},"/api/ops/actions/reading.record":{"post":{"operationId":"reading_record","tags":["asset"],"summary":"Record a reading of an asset","description":"Record one reading on an asset with no work order (a meter, a counter, a gauge, a measurement): what was read, its value and unit, when. Maintenance by meter and condition rules count it. For many at once, reading.record_batch; on a work order, record its reading task instead (task.record).","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"params":{"type":"object","properties":{"assetId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"the asset read (or the target"},"title":{"type":"string","description":"what was read, such as Running hours (as a reading task names it"},"value":{"type":"number"},"note":{"type":"string"},"readAt":{"type":"string","format":"date-time","description":"it was read: 2026-10-16T09:30 (UTC unless it says its offset); empty: now"},"unit":{"type":"string","description":"its unit, such as h (empty: none"}},"required":["assetId","title","value"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"Running hours","value":{"params":{"assetId":"bms:AHU-3","title":"Running hours","value":18234,"unit":"h","readAt":"2026-11-03T06:00Z"}}},"example2":{"summary":"A gauge read on a round","value":{"params":{"assetId":"6a1b3c5d-0000-4000-8000-000000000013","title":"Discharge pressure","value":4.6,"unit":"bar","note":"Needle steady"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"reading.record","objectKind":"asset","destructive":false,"planPart":"OPERATIONS","needsTarget":false,"autonomyTier":1,"since":"2026-10-24"}}},"/api/ops/actions/request.assign":{"post":{"operationId":"request_assign","tags":["request"],"summary":"Pass request to a team","description":"Give a request to a team, the people who will sort it or do the work. To give work to a person, make a work order for the request and assign that (work_order.create, work_order.assign).","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"expectedVersion":{"type":"integer"},"teamId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"Give it to a team","value":{"target":"bms:ALM-88213","params":{"teamId":"3f1c2a9e-0000-4000-8000-000000000001"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"request.assign","objectKind":"request","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/request.raise":{"post":{"operationId":"request_raise","tags":["request"],"summary":"Raise request","description":"Raise a request (a ticket, a call-out, a fault report): report a fault, a need or a finding at a location or on an asset. Use it when someone reports something wrong or needed; it is not yet work for anyone (make a work order for that). Routing rules choose the team, time targets start and the right people are told, as for a person. It needs a summary, the kind of request and where it is: a location, an asset at one, or both (people in the app are refused with neither; a connected system may still leave both out). Raising it for someone else (reportedById) needs the right to raise requests for someone else (a connected system needs only to raise requests). Coming from another system, send outsideId with that system's ticket id so a repeat makes nothing twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"params":{"type":"object","properties":{"classKey":{"type":"string","description":"The kind of request, a key from GET /api/ops/registry (classes of kind request), never a work order's kind such as corrective","examples":["hardware_failure"]},"summary":{"type":"string","description":"Its title: what is wrong or needed, in one short line","examples":["Chiller 2 trips on high pressure"]},"assetId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"The asset it is about (or system:id); its location is taken when locationId is left out"},"attrs":{"type":"object","description":"Values for the kind's own fields, by field key (GET /api/ops/registry)"},"details":{"type":"string","description":"Its description: what was seen, since when, anything that helps the team; optional","examples":["It trips about an hour after start-up, mostly in the afternoon. The pressure reads 21 bar just before."]},"detectionMethod":{"type":"string","description":"How it was found, such as an alarm or an inspection"},"entityId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"a legal entity in the company's group; null: its place's, or the one above"},"findingIds":{"type":"array","items":{}},"impact":{"type":"string","description":"ONE (one asset or room), SEVERAL or SITE (the whole site): with the company's grid, the severity is worked out from it and the severity said (its urgency)"},"incidentTypeId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"internal":{"type":"boolean"},"locationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"Where: a location id (or system:id). Give a location, an asset at one, or both (needed in the app; a connected system may leave both out)"},"photos":{"type":"array","items":{},"description":"of {url, name, contentType, sizeBytes}: photos, videos or PDFs of the fault, uploaded first (POST /api/ops/uploads"},"punchListId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"a punch list it is an item of: its place, team and kind unless given here"},"reportedById":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"who reported it, when someone raises it for them: a person who called or wrote; needs the right to raise requests for someone else"},"reportedVia":{"type":"string","enum":["APP","PHONE","CHAT","EMAIL","ON_SITE"],"description":"APP | PHONE | CHAT | EMAIL | ON_SITE (how it came in; APP when left out)"},"severity":{"type":"string","enum":["MINOR","MODERATE","MAJOR","CRITICAL"],"description":"How bad it is; the company's own words for each are in GET /api/ops/settings"},"teamId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"A team to give it to; left out, the company's routing rules choose"},"outsideId":{"type":"string","description":"The other system's id for it, system:id; it is then made once"}},"required":["classKey","summary"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"A leak a technician reported","value":{"params":{"summary":"Water leaking under the plant room door","details":"A puddle by the door since this morning; it seems to come from the pipe above the ceiling.","classKey":"leak","locationId":"9e8d7c6b-0000-4000-8000-000000000014","severity":"MODERATE"}}},"example2":{"summary":"An alarm from a building management system","value":{"params":{"summary":"AHU-3 supply fan failed","classKey":"hardware_failure","assetId":"bms:AHU-3","severity":"MAJOR","detectionMethod":"alarm","outsideId":"bms:ALM-88213"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"request.raise","objectKind":"request","destructive":false,"planPart":"OPERATIONS","needsTarget":false,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/request.transition":{"post":{"operationId":"request_transition","tags":["request"],"summary":"Change request status","description":"Move a request to another step of its flow: start it, put it on hold, mark it fixed, confirm it, close or cancel it. The steps it may go to next are on its read (GET /api/ops/requests/{id}, next) and GET /api/ops/requests/{id}/checks says what each would need. The flow's rules hold: required fields, who may make the move, approvals.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"to":{"type":"string","description":"The key of the step to move to, one of the request's next steps"},"attrs":{"type":"object"},"expectedVersion":{"type":"integer"},"note":{"type":"string","description":"Why, kept with the move"}},"required":["to"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"Close a request the other system resolved","value":{"target":"bms:ALM-88213","params":{"to":"closed","note":"Alarm cleared at the source"}}},"example2":{"summary":"Confirm a fix as the person who raised it","value":{"targetId":"8d4f6b2a-0000-4000-8000-000000000011","params":{"to":"closed","note":"Checked on site, no more water"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"request.transition","objectKind":"request","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/request.update":{"post":{"operationId":"request_update","tags":["request"],"summary":"Edit request","description":"Change what a request says: its summary (title), description (details), severity, kind, location, asset or fields. Use it to correct or add to a request; a new severity, kind or place matches its time target again. Not its step (request.transition) nor its team (request.assign). A closed or cancelled request stays as it was.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"assetId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"null takes the asset off"},"attrs":{"type":"object","description":"fields to change; null removes one"},"classKey":{"type":"string"},"details":{"type":"string","description":"its description; empty takes it off"},"entityId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"a legal entity in the company's group; null: its place's, or the one above"},"expectedVersion":{"type":"integer","description":"The version you read; the change is refused when someone changed it since"},"impact":{"type":"string","enum":["ONE","SEVERAL","SITE"],"description":"ONE | SEVERAL | SITE"},"locationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"severity":{"type":"string","enum":["MINOR","MODERATE","MAJOR","CRITICAL"],"description":"MINOR | MODERATE | MAJOR | CRITICAL (its urgency, with the company's grid)"},"summary":{"type":"string","description":"its title"}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"Raise the severity","value":{"target":"bms:ALM-88213","params":{"severity":"CRITICAL"}}},"example2":{"summary":"Say which asset it is about","value":{"targetId":"8d4f6b2a-0000-4000-8000-000000000011","params":{"assetId":"6a1b3c5d-0000-4000-8000-000000000013"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"request.update","objectKind":"request","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/stock.receive":{"post":{"operationId":"stock_receive","tags":["stock"],"summary":"Receive parts into a storeroom","description":"Receive parts into a store (by id or code), at a cost, without a purchase order (for an order, purchase_order.receive). The average cost follows. A part tracked one by one names each serial received.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"params":{"type":"object","properties":{"quantity":{"type":"number"},"currency":{"type":"string"},"note":{"type":"string"},"partCode":{"type":"string"},"partId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"rate":{"type":"number"},"serials":{"type":"array","items":{},"description":"a part tracked one by one, the serial number of each one received"},"spotCode":{"type":"string"},"spotId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"storeCode":{"type":"string"},"storeId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"unitCost":{"type":"number"},"vendorId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]}},"required":["quantity"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"Ten filters","value":{"params":{"storeCode":"MAIN","partCode":"FLT-600","quantity":10,"unitCost":31.8,"currency":"EUR"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"stock.receive","objectKind":"stock","destructive":false,"planPart":"STOCK","needsTarget":false,"autonomyTier":3,"since":"2026-10-24"}}},"/api/ops/actions/task.record":{"post":{"operationId":"task_record","tags":["task"],"summary":"Record a task","description":"Record one task of a work order (the task is the target): done or not, its answer or reading, a note. Out of range readings are marked. For several tasks at once, work_order.record_tasks.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"done":{"type":"boolean"},"note":{"type":"string"},"photos":{"type":"array","items":{}},"readAt":{"type":"string","format":"date-time","description":"a reading was taken: 2026-10-16T09:30 (UTC unless it says its offset); empty: now"},"removePhotoIds":{"type":"array","items":{}},"value":{"type":["number","string"]}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"A reading","value":{"targetId":"7a0e5f3c-0000-4000-8000-000000000003","params":{"value":61.5,"done":true}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"task.record","objectKind":"task","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/time.log":{"post":{"operationId":"time_log","tags":["work_order"],"summary":"Log time on a work order","description":"Log time worked on a work order (the target) for a person who is on it: how long and on which day. Logging someone else's time needs the right to assign the work.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"personId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"time":{"type":"string","description":"How long: 1h30, 90m, 1.5h or 0:45","examples":["1h30"]},"note":{"type":"string"},"workedOn":{"type":"string","format":"date","description":"The day it was worked; today when left out"}},"required":["personId","time"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"An hour and a half yesterday","value":{"target":"erp:WO-55120","params":{"time":"1h30","workedOn":"2026-11-03","personId":"5b2d7c1e-0000-4000-8000-000000000002"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"time.log","objectKind":"time_entry","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/vendor.save":{"post":{"operationId":"vendor_save","tags":["stock"],"summary":"Save a vendor","description":"Add a supplier, or change one (the target): names, contacts, currency, payment terms, tax number, bank details.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it changes (ours); left out, it makes a new one. Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"name":{"type":"string"},"active":{"type":"boolean"},"address":{"type":"string"},"bankAccountName":{"type":"string","description":"whose account it is"},"bankAccountNumber":{"type":"string"},"bankBranch":{"type":"string"},"bankName":{"type":"string"},"code":{"type":"string"},"contactEmail":{"type":"string"},"contactName":{"type":"string"},"contactPhone":{"type":"string"},"currency":{"type":"string"},"legalName":{"type":"string","description":"as on its invoices"},"localName":{"type":"string","description":"the legal name in the local language"},"paymentTermsDays":{"type":"integer"},"swiftCode":{"type":"string","description":"8 or 11 letters and digits"},"taxNumber":{"type":"string"},"outsideId":{"type":"string","description":"Another system's id for what this makes, written system:id; sent again, it answers with the record made before"}},"required":["name"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"A supplier","value":{"params":{"name":"Northside Filters","code":"NSF","currency":"EUR","paymentTermsDays":30}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"vendor.save","objectKind":"vendor","destructive":false,"planPart":"STOCK","needsTarget":false,"autonomyTier":3,"since":"2026-10-24"}}},"/api/ops/actions/work_order.assign":{"post":{"operationId":"work_order_assign","tags":["work_order"],"summary":"Assign work order","description":"Give a work order to a team, a person, or both, and set who else is on it (crewIds, the whole list). Use it to dispatch work to a technician. The certificates the work needs are checked for each person.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"assigneeId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"crewIds":{"type":"array","items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"description":"everyone else on the work order besides its person: the whole list; [] for nobody"},"deadline":{"type":"string","format":"date"},"expectedVersion":{"type":"integer"},"note":{"type":"string","description":"a few words more on the reason"},"reason":{"type":"string","enum":["when","AVAILABLE_SOONER","CLIENT_ASKED","TRAINING","SHARING_WORK","OTHER"],"description":"when assigneeId is not suggestedId: KNOWS_THE_SITE | AVAILABLE_SOONER | CLIENT_ASKED | TRAINING | SHARING_WORK | OTHER"},"suggestedId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"who \"Who could do it\" put first, when the screen showed it"},"teamId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"Give it to a person","value":{"target":"erp:WO-55120","params":{"assigneeId":"5b2d7c1e-0000-4000-8000-000000000002"}}},"example2":{"summary":"A team and two people","value":{"targetId":"2c7e9a14-0000-4000-8000-000000000012","params":{"teamId":"3f1c2a9e-0000-4000-8000-000000000001","assigneeId":"5b2d7c1e-0000-4000-8000-000000000002","crewIds":["5b2d7c1e-0000-4000-8000-000000000042"]}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"work_order.assign","objectKind":"work_order","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/work_order.create":{"post":{"operationId":"work_order_create","tags":["work_order"],"summary":"Create work order","description":"Make a work order (a job): work for someone to do at a location or on assets, optionally answering requests, with the tasks of its kind and a checklist. Use it when a request needs work, or to plan corrective or preventive work directly. Approval rules, certificates and permits hold as for a person. Needs a title; give the kind, where, the requests it answers, a priority and a due date when known. Coming from another system, send outsideId with that system's order number so a repeat makes nothing twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"params":{"type":"object","properties":{"title":{"type":"string","description":"What is to be done, in one line","examples":["Replace the AHU-3 fan belt"]},"assetId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"assetIds":{"type":"array","items":{},"description":"the assets it is about, in order: a round of several"},"assigneeId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"attrs":{"type":"object"},"checklistId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"a checklist whose tasks it also gets, after its kind's (V331"},"classKey":{"type":"string","description":"The kind of work, a key from GET /api/ops/registry (classes of kind work_order)"},"deadline":{"type":"string","format":"date","description":"When it is due: a day (2026-11-03) or a time"},"description":{"type":"string"},"entityId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"a legal entity in the company's group; null: its place's, or the one above"},"estimatedHours":{"type":"number","description":"the hours the work should take (V317"},"locationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"move":{"type":"boolean","description":"Take requests already on another open work order off it; left out, people in the app are refused and a connected system moves it"},"parentId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"priority":{"type":"string","enum":["ROUTINE","PLANNED","URGENT","EMERGENCY"],"description":"Left out with requests: their worst severity sets it, as the company's settings map them"},"projectId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"requestIds":{"type":"array","items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"description":"Requests it answers (ids or system:id); they follow it and close when it is done"},"tasks":{"type":"array","items":{},"description":"Tasks to add after its kind's: each {title, kind: CHECK|READING|TEXT|CHOICE|PHOTO, required, unit}"},"teamId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"outsideId":{"type":"string","description":"The other system's id for it, system:id; it is then made once"}},"required":["title"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"Work for a request","value":{"params":{"title":"Fix the leak under the plant room door","classKey":"corrective","requestIds":["8d4f6b2a-0000-4000-8000-000000000011"],"priority":"URGENT","deadline":"2026-11-04"}}},"example2":{"summary":"A work order from another system's job","value":{"params":{"title":"Quarterly fire door check, block B","classKey":"preventive","locationId":"erp:SITE-B","priority":"PLANNED","deadline":"2026-11-30","outsideId":"erp:WO-55120"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"work_order.create","objectKind":"work_order","destructive":false,"planPart":"OPERATIONS","needsTarget":false,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/work_order.record_tasks":{"post":{"operationId":"work_order_record_tasks","tags":["work_order"],"summary":"Record several tasks of a work order","description":"Record several tasks of a work order at once, each by its id or its title: done or not, a reading's value, a note. Use it when a technician reports a few things together. All or nothing.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"tasks":{"type":"array","items":{},"description":"of {taskId or title, done, value, note, readAt}"}},"required":["tasks"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"Two readings and a check","value":{"target":"erp:WO-55120","params":{"tasks":[{"title":"Suction pressure","value":4.2},{"title":"Discharge pressure","value":15.8},{"title":"Belt tension checked","done":true}]}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"work_order.record_tasks","objectKind":"work_order","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/work_order.schedule":{"post":{"operationId":"work_order_schedule","tags":["work_order"],"summary":"Plan a work order on the schedule","description":"Put a work order on the schedule (a start and hours), or take it off; optionally give it to a person. Use it to plan who does what on which day; GET /api/ops/schedule shows the board. Warns for a client that agrees visits first, a day fuller than the person works, or a due date before the day.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"assigneeId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"give it to this person (leave out to keep its person"},"hours":{"type":"string","description":"how long it takes, in hours (empty: not said)"},"start":{"type":"string","description":"when it starts: 2026-10-09T09:00 (in timeZone), a day (2026-10-09: when the person's day starts), or empty to take it off the schedule"},"timeZone":{"type":"string","description":"the zone start is written in, such as Europe/London (else the person's own, else UTC)"}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"Plan it for a morning","value":{"target":"erp:WO-55120","params":{"start":"2026-11-04T08:00","hours":2,"timeZone":"Europe/London"}}},"example2":{"summary":"Plan it for someone else","value":{"targetId":"2c7e9a14-0000-4000-8000-000000000012","params":{"start":"2026-11-05T13:00","hours":3,"assigneeId":"5b2d7c1e-0000-4000-8000-000000000002"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"work_order.schedule","objectKind":"work_order","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/work_order.transition":{"post":{"operationId":"work_order_transition","tags":["work_order"],"summary":"Change work order status","description":"Move a work order to another step of its flow: send it out, start, put on hold, finish, close or cancel it. The steps it may go to next are on its read (GET /api/ops/work-orders/{id}, next) and GET /api/ops/work-orders/{id}/checks says what each would need. Required tasks, failure reports, permits, agreed visits, certificates and approvals hold as for a person.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"to":{"type":"string"},"attrs":{"type":"object"},"expectedVersion":{"type":"integer"},"whatWasDone":{"type":"string","description":"what was done, kept as a shared message on the work order and on each request it finishes"}},"required":["to"]},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}},"required":["params"]},"examples":{"example1":{"summary":"Mark it done","value":{"target":"erp:WO-55120","params":{"to":"completed"}}},"example2":{"summary":"Mark it done and say what was done","value":{"target":"erp:WO-55120","params":{"to":"completed","whatWasDone":"Replaced the valve seal and tested for leaks"}}},"example3":{"summary":"Put it on hold","value":{"targetId":"2c7e9a14-0000-4000-8000-000000000012","params":{"to":"on_hold"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"work_order.transition","objectKind":"work_order","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/actions/work_order.update":{"post":{"operationId":"work_order_update","tags":["work_order"],"summary":"Edit work order","description":"Change what a work order says: title, description, priority, deadline, kind, location, fields, estimated hours. Not its step (work_order.transition), people (work_order.assign) or schedule (work_order.schedule).","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","format":"uuid","description":"What it acts on (ours). Or target."},"target":{"type":"string","description":"What it acts on, as another system's id: system:id"},"params":{"type":"object","properties":{"attrs":{"type":"object","description":"fields to change; null removes one"},"classKey":{"type":"string"},"deadline":{"type":"string","format":"date","description":"YYYY-MM-DD) or time; null takes it off"},"description":{"type":"string"},"entityId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}],"description":"a legal entity in the company's group; null: its place's, or the one above"},"estimatedHours":{"type":"number","description":"the hours the work should take; null takes it off (V317"},"expectedVersion":{"type":"integer","description":"The version you read; the change is refused when someone changed it since"},"locationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[^:\\s]+:.+$"}]},"priority":{"type":"string","enum":["ROUTINE","PLANNED","URGENT","EMERGENCY"],"description":"ROUTINE | PLANNED | URGENT | EMERGENCY"},"title":{"type":"string"}}},"dryRun":{"type":"boolean","description":"true: see what it would do; nothing is kept"}}},"examples":{"example1":{"summary":"Move the deadline","value":{"target":"erp:WO-55120","params":{"deadline":"2026-12-05"}}},"example2":{"summary":"Make it urgent","value":{"targetId":"2c7e9a14-0000-4000-8000-000000000012","params":{"priority":"URGENT"}}}}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOutcome"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"work_order.update","objectKind":"work_order","destructive":false,"planPart":"OPERATIONS","needsTarget":true,"autonomyTier":2,"since":"2026-10-24"}}},"/api/ops/readings/batch":{"post":{"operationId":"readings_batch","tags":["asset"],"summary":"Send readings","description":"Record up to 1,000 readings at once. Each is matched to exactly one asset by our id, its number, its code, its serial or system:id; a reading that matches none, or more than one, is refused alone with why, and the rest are kept. readAt is required and never in the future; a unit must match the readings before it. A key made for readings only opens this and nothing else.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/OrbitifyVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["readings"],"properties":{"readings":{"type":"array","maxItems":1000,"items":{"type":"object","required":["asset","title","value","readAt"],"properties":{"asset":{"type":"string","description":"The asset: our id, its number (AST-00128), its code, its serial or system:id; exactly one asset must match"},"title":{"type":"string","maxLength":255,"description":"What was read, such as Running hours"},"value":{"type":"number"},"unit":{"type":"string","maxLength":32,"description":"Its unit; the same as the readings before it"},"readAt":{"type":"string","format":"date-time","description":"When it was read; UTC unless it says its offset; never in the future"},"note":{"type":"string"}}}},"dryRun":{"type":"boolean"}}},"example":{"readings":[{"asset":"AST-00128","title":"Energy","value":50213.4,"unit":"kWh","readAt":"2026-11-03T06:00Z"},{"asset":"bms:AHU-3","title":"Running hours","value":18240,"unit":"h","readAt":"2026-11-03T06:00Z"}]}}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ActionOutcome"}],"description":"summary.recorded: how many were kept; summary.refused: [{index, asset, why}] for each one refused"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}},"x-orbitify":{"action":"reading.record_batch","since":"2026-10-24"}}},"/api/ops/live/ingest":{"post":{"operationId":"live_ingest","tags":["live"],"summary":"Send a site's live readings","description":"Up to 5,000 readings a call, 4 MB at most, with a key of purpose LIVE (made on the source's page in Settings > Live data sources), which opens this and nothing else. A reading of a tag at a time already kept is kept once, so a buffer may be sent again after an outage; no Idempotency-Key. Also accepted: a bare array of readings, Telegraf's JSON ({\"metrics\": [...]}, each field the tag <device>.<field>) and CSV (text/csv, lines of tag,at,value[,quality], a header line allowed).","security":[{"liveKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["readings"],"properties":{"readings":{"type":"array","maxItems":5000,"items":{"type":"object","required":["tag","at","value"],"properties":{"tag":{"type":"string","maxLength":200,"description":"The point as the site names it, such as INV-03.Temp_Bearing; a tag never seen waits to be mapped to an asset's reading"},"at":{"type":["string","number"],"description":"When it was read: ISO 8601 (UTC unless it says its offset) or seconds since 1970 (milliseconds when that large); never more than 5 minutes ahead"},"value":{"type":["number","string","boolean"],"description":"A number, a number as text, or true and false (1 and 0)"},"quality":{"type":["string","integer"],"enum":["good","uncertain","bad",0,1,2],"description":"good when left out; a bad reading is kept but never read by rules"}}}}}},"example":{"readings":[{"tag":"INV-03.Temp_Bearing","at":"2026-10-23T14:02:00Z","value":71.5},{"tag":"INV-03.Power","at":"2026-10-23T14:02:00Z","value":412,"quality":"good"}]}},"text/csv":{"schema":{"type":"string"},"example":"tag,at,value,quality\nINV-03.Power,2026-10-23T14:02:00Z,412,good\n"}}},"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"type":"object","properties":{"sent":{"type":"integer"},"kept":{"type":"integer"},"sentBefore":{"type":"integer","description":"Already kept from an earlier call"},"notKept":{"type":"integer","description":"Of ignored tags"},"newTags":{"type":"integer","description":"Tags seen for the first time, waiting to be mapped"},"refused":{"type":"array","description":"The first 100 refused, each with why","items":{"type":"object","properties":{"index":{"type":"integer"},"tag":{"type":"string"},"why":{"type":"string"}}}},"refusedCount":{"type":"integer"}}}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}}}},"/api/ops/events":{"get":{"operationId":"events","tags":["events"],"summary":"Events, oldest first","description":"What happened, oldest first, only about records the connection may read. Keep `next` and send it as `after` next time; while `more` is true, ask again at once. Events are kept 30 days.","parameters":[{"name":"after","in":"query","schema":{"type":"integer","format":"int64","default":0},"description":"The seq of the last event read; 0 for the first"},{"name":"types","in":"query","schema":{"type":"string"},"description":"Kinds to keep, comma-separated (request.raised,work_order.transitioned); all when left out"},{"name":"limit","in":"query","schema":{"type":"integer","default":100,"maximum":500}}],"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Event"}],"properties":{"id":{"type":"string","format":"uuid"},"seq":{"type":"integer","format":"int64"}}}},"next":{"type":"integer","format":"int64"},"more":{"type":"boolean"}}}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}}}},"/api/ops/registry":{"get":{"operationId":"read_registry","tags":["reads"],"summary":"Kinds, fields and flows","description":"The company's kinds of location, asset, request and work order (their keys are classKey), their fields (attrs) and the steps of each flow (the keys a move goes to). Reads are under the connection's own rights: what its roles may see.","responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}}}},"/api/ops/requests/{id}":{"get":{"operationId":"read_requests","tags":["reads"],"summary":"One request","description":"A request with its step and `next`: the steps it may move to now. Reads are under the connection's own rights: what its roles may see.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}}}},"/api/ops/work-orders/{id}":{"get":{"operationId":"read_work_orders","tags":["reads"],"summary":"One work order","description":"A work order with its step, tasks and `next`. Reads are under the connection's own rights: what its roles may see.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}}}},"/api/ops/assets/{id}":{"get":{"operationId":"read_assets","tags":["reads"],"summary":"One asset","description":"An asset with its location and fields. Reads are under the connection's own rights: what its roles may see.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}}}},"/api/ops/test-company":{"get":{"operationId":"read_test_company","tags":["reads"],"summary":"Whether this is a test company","description":"testOf: the company this is a test of (id and name); null in a real company. Reads are under the connection's own rights: what its roles may see.","responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Refused: what is missing or wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"401":{"description":"No key, or a key that is off or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"403":{"description":"Its roles do not allow it, a connection does not run it, or the connection is switched off or paused","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"404":{"description":"Not found, or not visible to it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"409":{"description":"Refused by a rule: the flow, an approval, a version that moved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}},"429":{"description":"Too many calls: wait as Retry-After (and the message) says","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}}}}}}},"webhooks":{"request.raised":{"post":{"operationId":"event_request_raised","summary":"request.raised","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"request.transitioned":{"post":{"operationId":"event_request_transitioned","summary":"request.transitioned","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"request.assigned":{"post":{"operationId":"event_request_assigned","summary":"request.assigned","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"request.updated":{"post":{"operationId":"event_request_updated","summary":"request.updated","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"request.merged":{"post":{"operationId":"event_request_merged","summary":"request.merged","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"work_order.created":{"post":{"operationId":"event_work_order_created","summary":"work_order.created","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"work_order.transitioned":{"post":{"operationId":"event_work_order_transitioned","summary":"work_order.transitioned","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"work_order.assigned":{"post":{"operationId":"event_work_order_assigned","summary":"work_order.assigned","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"work_order.scheduled":{"post":{"operationId":"event_work_order_scheduled","summary":"work_order.scheduled","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"work_order.updated":{"post":{"operationId":"event_work_order_updated","summary":"work_order.updated","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"asset.created":{"post":{"operationId":"event_asset_created","summary":"asset.created","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"asset.updated":{"post":{"operationId":"event_asset_updated","summary":"asset.updated","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"asset.moved":{"post":{"operationId":"event_asset_moved","summary":"asset.moved","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"asset.disposed":{"post":{"operationId":"event_asset_disposed","summary":"asset.disposed","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"reading.recorded":{"post":{"operationId":"event_reading_recorded","summary":"reading.recorded","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"location.created":{"post":{"operationId":"event_location_created","summary":"location.created","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"location.updated":{"post":{"operationId":"event_location_updated","summary":"location.updated","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"reading.batch_recorded":{"post":{"operationId":"event_reading_batch_recorded","summary":"reading.batch_recorded","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"stock.received":{"post":{"operationId":"event_stock_received","summary":"stock.received","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"stock.moved":{"post":{"operationId":"event_stock_moved","summary":"stock.moved","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"purchase_order.issued":{"post":{"operationId":"event_purchase_order_issued","summary":"purchase_order.issued","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"purchase_order.received":{"post":{"operationId":"event_purchase_order_received","summary":"purchase_order.received","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"approval.requested":{"post":{"operationId":"event_approval_requested","summary":"approval.requested","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"approval.approved":{"post":{"operationId":"event_approval_approved","summary":"approval.approved","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"approval.refused":{"post":{"operationId":"event_approval_refused","summary":"approval.refused","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"import.done":{"post":{"operationId":"event_import_done","summary":"import.done","description":"Sent when it happens, to every address of a connection that asked for it and may read the record. Never sent back to the connection that made the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}},"connector.ping":{"post":{"operationId":"event_connector_ping","summary":"connector.ping","description":"Sent by Send a test in Settings: this address can be reached.","parameters":[{"name":"webhook-id","in":"header","required":true,"schema":{"type":"string"},"description":"The event's id, the same on every try: drop one already handled"},{"name":"webhook-timestamp","in":"header","required":true,"schema":{"type":"integer"},"description":"Seconds since 1970; refuse one more than 5 minutes off"},{"name":"webhook-signature","in":"header","required":true,"schema":{"type":"string"},"description":"v1,<base64 HMAC-SHA256 of \"webhook-id.webhook-timestamp.body\" with the secret's bytes (after whsec_)>; two, space-separated, for a day after the secret changes"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"2XX":{"description":"Received. Anything else, or no answer within 15 seconds, is tried again: at once, then after 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 14 h, 20 h and 24 h. 410 switches the address off; so do five days of failing."}}}}},"components":{"schemas":{"ActionOutcome":{"type":"object","properties":{"action":{"type":"string"},"objectKind":{"type":"string"},"objectId":{"type":"string","format":"uuid"},"dryRun":{"type":"boolean"},"summary":{"type":"object","description":"What it did; existing: true when an outsideId had made it before"},"warnings":{"type":"array","items":{"type":"string"}}}},"Refusal":{"type":"object","properties":{"message":{"type":"string","description":"Why, in words; in the language of Accept-Language"}}},"Event":{"type":"object","required":["type","timestamp","data"],"properties":{"type":{"type":"string","description":"The kind of event, such as work_order.transitioned"},"timestamp":{"type":"string","format":"date-time"},"data":{"type":"object","description":"What changed and where to look: id, number, kind, step, meaning (its fixed meaning: RAISED, PLANNED, DISPATCHED, EXECUTED, CLOSED, ...), version, placeId, projectId, assetId, changed, source. Never money, names, emails or phone numbers."}}}},"parameters":{"IdempotencyKey":{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Unique per change; sending a change again with the same key is answered from the first time"},"OrbitifyVersion":{"name":"Orbitify-Version","in":"header","required":false,"schema":{"type":"string","enum":["2026-10-24"]},"description":"The API version the call was written for; today's when left out. Every answer names the version it followed in the same header; a version no longer answered is refused (400)."}},"securitySchemes":{"connectionKey":{"type":"http","scheme":"bearer","description":"A key made in Settings > Connected systems"},"liveKey":{"type":"http","scheme":"bearer","description":"A live data key, made on a source's page in Settings > Live data sources"}}}}