Autologyx Docs

Appearance

🔌 Catalyst API ​

Welcome to the Autologyx Catalyst API documentation.

This section provides the technical reference material needed to integrate with Catalyst services, understand the structure and conventions of the platform APIs, and work effectively with related features such as merge fields, event history, and WebSockets.

📚 What this section covers ​

The API documentation is organised into a small number of focused areas:

🔗 API service documentation ​

🛠️ Technical documentation ​

  • API Standards
    Shared conventions, structures, and behaviours used across the API surface.

  • Understanding Merge Fields
    Reference documentation for merge field syntax, usage patterns, and supported structures.

👥 Who this documentation is for ​

This section is primarily intended for:

  • Developers and integrators building against the Catalyst APIs
  • Configuration admins working with advanced platform integrations
  • Technical users who need to understand payload structure, merge field syntax, and API conventions
  • Teams implementing real-time or event-driven workflows

🧭 How to use this documentation ​

If you are new to the API documentation, a good place to start is:

  1. API Standards to understand common patterns and conventions
  2. Catalyst Platform API for the core service reference
  3. Understanding Merge Fields if your use case involves dynamic values in templates, messages, or automation
  4. Event History API or WebSockets if you are working with history, monitoring, or real-time updates

🎯 Common use cases ​

Teams typically use this documentation when they need to:

  • integrate external systems with Catalyst
  • retrieve or update platform data programmatically
  • understand API request and response conventions
  • work with merge fields in documents, messages, or workflow configuration
  • consume event history for reporting, monitoring, or audit-related scenarios
  • build real-time integrations using WebSockets

🕒 Last updated ​

API Version 14.0.0 / 25-04-2026

This API documentation is maintained as part of the wider Autologyx Docs project and should be treated as the technical entry point for working with Catalyst services and related platform conventions.

WARNING

For the most accurate and current implementation detail, always check the specific service or standards page you are working from, especially when dealing with request and response structures, merge field syntax, event data, or real-time integration behaviour.

ℹ️ Notes ​

INFO

This API documentation is intended to complement the Catalyst Knowledgebase.
Use the Knowledgebase for broader platform guidance and configuration workflows, and use this section when you need technical reference material for implementation.

TIP

If you already know which area you need, use the navigation to jump directly to the relevant API or technical reference section.