API reference
Post a status notice
Publish a public incident or a maintenance window with its first update. It shows at once on a published page. Owner or admin.
Needs scope connections:write.
bearerAuthorizationBearer <JWT>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.
org_id*stringThe account's id: org in GET /v1/me.
page_id*stringThe page's id, from List status pages.
iohr.connections.v1.CreateStatusNoticeRequest; path variables override their fields
application/json- body
iohr.connections.v1.CreateStatusNoticeRequest
body?stringends_at?stringimpacts?array<>incident_id?stringkind?stringorg_id?stringpage_id?stringstarts_at?stringstate?stringtitle?stringiohr.connections.v1.CreateStatusNoticeResponse
application/json- response
iohr.connections.v1.CreateStatusNoticeResponse
notice?iohr.connections.v1.StatusNotice
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try { const { value } = await api.connections.createStatusNotice("<org_id>", "<page_id>", { body: "<body>", ends_at: "<ends_at>", kind: "<kind>", starts_at: "<starts_at>", }); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`); process.exitCode = 1;}npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.
{ "notice": { "ends_at": "string", "id": "string", "impacts": [ { "component_id": "string", "impact": "string" } ], "incident_id": "string", "kind": "string", "resolved_at": "string", "starts_at": "string", "state": "string", "title": "string", "updates": [ { "body": "string", "by_role": "string", "created_at": "string", "id": "string", "state": "string" } ] }}