Home

Welcome to the documentation of Work API, the main data source of the ProcessMaker Process Intelligence platform. The platform used to be called Workfellow, so there might be references to that in the documentation.

This documentation is designed to assist Work API developers in harnessing the full potential of our Work API, enabling seamless data collection from your business applications and processes. This document helps you to leverage the capabilities of our three key components of Work API: the Windows Agent, Configuration Tooling, and Creating Data Collection Configurations.

Throughout this documentation, we aim to provide you with comprehensive examples, detailed explanations, and step-by-step guides to maximize your understanding and productivity. So, let's dive in and explore the powerful capabilities of our Work API.

Windows Agent

Windows Agent is a part of Work API that enables real-time and reliable data gathering from Windows-based systems. By utilizing the Windows Agent, you can efficiently collect a wide range of process, task, and business information with the desired granularity levels based on the defined data collection configurations.

Data Collection Configurations

Creating Data Collection Configurations is the final segment of our API documentation, providing Work API developers with the means to define and customize data collection configurations using the Work API syntax language. With this, you can create flexible, reusable, and dynamic configurations to gather specific data from various systems and applications.

Tutorials and Training

The Tutorials and Training section provides examples, use cases, and best practices to effectively configure Work API.