Skip to content

POST /event

Record Event

POST
/event

Record a single domain event.

Dispatches an event of the type specified in event_data.event_type through
the event class registry. The event's save() method runs pre_processing,
apply (inside an ArangoDB transaction), store_event, and
post_processing. Returns the event's response payload on success.

Emits: (dynamic — event class resolved from event_type field at runtime)
Required scope: traceability:event:create

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Request Body

application/json
JSON
{
  
"_key": "string",
  
"event_type": "string",
  
"event_group": "string",
  
"primary": true,
  
"context_type": "string",
  
"context_key": "string",
  
"user_key": "string",
  
"user_session_key": "string",
  
"timestamp": "string",
  
"description": "string",
  
"additionalProperties": "string"
}

Responses

Successful Response

application/json
JSON
{
  
"status": 200,
  
"message": "string",
  
"detail": "string"
}

Samples

Powered by VitePress OpenAPI

This endpoint dispatches all domain events. See the Events Reference for the complete list of events that can be emitted through this endpoint.

Released under the Apache 2.0 License.