Home Documentation Workflow Management Service Workflow Integration Guides

Workflow Integration Guides

Last updated: April 2026

Welcome to the Integration Guides for the Agglestone Workflow Management Service. These guides explain how to work with the public API endpoints, show common request patterns, and provide example payloads you can adapt for your own tenant.

Getting Started

If you’re new to the service, start with the Quick Start Guide. It walks through the main flow of creating a workflow definition, starting a workflow item, updating it, and moving it through a transition.

Available Guides

Quick Start Guide

Get up and running with the core workflow APIs. Learn the base URL structure, authentication pattern, and the fastest way to create your first workflow definition and workflow item.

Workflow Definitions

Learn how to create, list, retrieve, update, delete, and version workflow definitions. This guide is the best place to start if you are designing a new workflow process.

Workflow Items

Understand how to create and manage live workflow items. Covers listing, filtering, sorting, field updates, transitions, rollback, history, bulk operations, and grouped queries.

Reference Data and Managed Data

Learn when to use reference data versus managed data, and how to work with the endpoints for both. Includes examples for lookup lists, shared business records, and workspace-aware data.

Files

Step-by-step guide to uploading files, retrieving metadata, and requesting signed URLs for browser-friendly access to stored files.

Utilities

Learn how to use the public holidays endpoint for country and region-aware date calculations.

Integration Paths

For Frontend Developers

  1. Start with the Quick Start Guide
  2. Review Workflow Items for list, update, and transition patterns
  3. Use Files if your workflow UI includes attachments or images
  4. Add Reference Data and Managed Data for lookups and reusable records

For Backend Developers

  1. Read Workflow Definitions to understand template management
  2. Review Workflow Items for operational workflows
  3. Use Reference Data and Managed Data for supporting datasets
  4. Check Utilities for holiday-aware automation or scheduling

For Full-Stack Developers

  1. Follow the Quick Start Guide
  2. Review the workflow and data guides to understand the full API surface
  3. Use Files for attachments
  4. Use your deployment’s Swagger UI to inspect exact schemas and optional properties

Base URL and Swagger

All examples in these guides use this route shape:

https://workflow.agglestone.com/tenant/{tenantId}/v1/...

For the full OpenAPI documentation and interactive testing, visit:

https://workflow.agglestone.com/swagger

Need Help?

—

Ready to get started? Begin with the Quick Start Guide and create your first workflow in minutes.