Report events

/v1/companies/{campus}/events

A local building’s node (factoryd) mirrors its own events up with the owner’s key; the rows join the log in order. Only a building with location: local that belongs to the company is accepted.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Path parameters

campusstringrequired

The company’s slug (plunge), never a row id

Query parameters

formatenum<string>

Response format; overrides Accept (an unknown value is 400 invalid_format)

Available options: json, yaml, markdown, text

Body

application/json
text/yaml

eventsobject[]required

Minimum array length: 1 Maximum array length: 200

Show child attributes

buildingstringrequired

item_idstring

officestring

typeenum<string>required

Available options: item.created, step.enter, step.exit, run.start, run.end, desk.progress, handoff, approval.requested, approval.decided, item.parked, item.resumed, item.done, budget.warn, budget.stop, config.changed, building.connected, item.then, error

dataobject

atstring

When it happened on the node (ISO 8601); defaults to receipt

Response

How many were taken Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.

application/json
text/yaml
text/markdown
text/plain

acceptedinteger

head_seqinteger

invalid_json — body is not valid JSON or YAML; invalid_format — format must be one of json, yaml, markdown, text

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

company_not_found — no company with that slug for this account (a foreign slug answers the same); not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

invalid_params — a field failed validation; nothing was written

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

upstream_error — the company service is unavailable; retry

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

not_enabled — the company service is not deployed on this tier

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

import os import requests response = requests.post( "https://api.plungeai.com/v1/companies/{campus}/events", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, json={ "events": [ { "building": "<string>", "type": "item.created", }, ], }, ) if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") print(response.json())

const response = await fetch('https://api.plungeai.com/v1/companies/{campus}/events', { method: 'POST', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "events": [ { "building": "<string>", "type": "item.created" } ] }), }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) console.log(await response.json())

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/companies/{campus}/events")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString("{\"events\":[{\"building\":\"<string>\",\"type\":\"item.created\"}]}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } System.out.println(response.body()); } }

curl -X POST 'https://api.plungeai.com/v1/companies/{campus}/events' \ -H "Authorization: Bearer $PLUNGE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{"events":[{"building":"<string>","type":"item.created"}]}'

Authorizations

Path parameters

Query parameters

Body

Response

Planned: TI-33

Planned: TI-34