🕘 Event History API Reference

Welcome to the Event History API reference.

This section documents the Event History microservice used to store, retrieve, and manage historical event data for Autologyx client environments. It covers the APIs used to initialise tenant storage, upload and retrieve associated files, and create or query event records.

WARNING

This section documents technical and service-level Event History APIs and is intended for internal platform use and controlled engineering workflows. It should not be treated as part of the main general-purpose external Catalyst integration surface. This area is outside general support coverage, so please contact your Customer Success team if you need guidance.

📚 What this section covers

The Event History API is organised around a small number of technical areas:

🧱 Tenant management

• Tenants
  Endpoints used to initialise and delete tenant-specific Event History storage and related service configuration.

📁 File handling

• Files
  Endpoints used to generate presigned upload URLs and manage file handling for history events with associated file content.

🧾 Event storage and retrieval

• Events
  Endpoints used to create history events, retrieve stored events, and access event-related file content.

🧩 How the service works

At a high level, the Event History service stores historical event data in tenant-specific storage. The attached technical pages show that tenant setup is handled separately, file upload support is provided through presigned URLs, and event records can then reference stored file content where needed. :contentReference[oaicite:4]{index=4} :contentReference[oaicite:5]{index=5} :contentReference[oaicite:6]

A typical flow looks like this:

1. A tenant is initialised for the client in the Event History service
2. A file upload URL is generated if an event needs to reference file content
3. The file is uploaded to storage
4. An event is created or ingested with the relevant metadata
5. Event records are later queried through the history endpoints

👥 Who this documentation is for

This section is primarily intended for:

• Autologyx internal developers
• platform and infrastructure engineers
• technical teams working on event ingestion, storage, or retrieval
• engineers integrating Catalyst services with the Event History microservice

🧭 How to use this documentation

A good reading order for this section is:

1. Start with Tenants to understand tenant initialisation and deletion
2. Continue with Files to understand presigned upload handling
3. Then use Events for event creation, querying, and event-related file access
4. Use Healthcheck and Version for service-level operational reference

🎯 Common use cases

Teams typically use this section when they need to:

• initialise Event History storage for a client
• upload files that must be associated with historical events
• create event records from platform or integration activity
• query stored event history for a given client
• retrieve file content linked to an event
• validate service health or deployed version