Changelog — v0.3

Release Date: May 2026

This release focuses entirely on documentation quality, structure, and completeness.

Documentation

Structure Changes

• Authentication moved to Guides — the Authentication page is now the first page of the Guides section, where it belongs alongside other operational topics
• Processes — the "Defining Processes" guide is renamed to "Processes" for brevity
• Instances — the "Managing Instances" guide is renamed to "Instances"
• Credentials reordered — the Credentials guide now appears before Service Tasks, since service task definitions reference credentials

Quickstart

• Added **Request:** / **Response:** labels to all API call/response pairs
• Added a new step 5. List Instances between completing a task and checking instance status
• Added a second process definition example using BPMN 2.0 XML (same expense-approval process), with a reference to the bpmn-xml-generator skill

Authentication

• Added **Request:** / **Response:** labels to all API call/response pairs
• Added missing response examples for: GET /v1/definitions (in the authentication example), GET /v1/tenant, and PUT /v1/tenant

Processes (formerly Defining Processes)

• Added **Request:** / **Response:** labels to all API call/response pairs, including versions, rollback, and export endpoints
• Added complete response examples for: list versions, get specific version, create new version
• Added a reference to the bpmn-xml-generator skill in the BPMN XML Format section

Service Tasks

• Added **Request:** / **Response:** labels to the async callback example
• Timeout clarified — the default timeout is 30 seconds (configurable via the timeout task header). On timeout, the request is treated as a failure and the retry policy applies
• Retry scope clarified — retries apply to synchronous mode only. In async mode there is no automatic retry on the initial HTTP call; the engine waits for the callback event, and if the timeout expires the instance moves to error
• Added a Service Task Lifecycle diagram showing the sync and async execution flows

Human Tasks

• Fixed the Task Lifecycle diagram formatting
• Added **Request:** / **Response:** labels to all API call/response pairs
• Added missing response examples for claim, unclaim, and delegate
• candidateGroups behavior clarified — candidateGroups is informational metadata stored on the task. The API does not enforce group membership at claim or delegate time; enforcement is the client's responsibility. There is no ?candidateGroup= filter in GET /tasks
• Added a brief introduction to the Patterns section

Instances (formerly Managing Instances)

• Fixed the Instance Lifecycle diagram formatting
• Added **Request:** / **Response:** labels to all API call/response pairs
• Added missing response examples for suspend, resume, and terminate
• Added response example for the correlation_id instance creation variant
• Added response example for the variables update endpoint

Webhooks

• Added **Request:** / **Response:** labels to all API call/response pairs
• Added response examples for: get subscription, update subscription, custom delivery headers creation
• Credentials not supported — clarified that the secret and headers fields in webhook subscriptions accept plain text only; {{credentials.*}} interpolation is not supported for webhooks

Clarifications Summary

Topic	Clarification
Service task timeout	Default is 30 s; configurable per task via timeout header
Service task retry	Retry applies to synchronous mode only; async mode has no automatic retry
Human task candidateGroups	Informational metadata only — API does not enforce group membership
Webhook credentials	secret and headers fields are plain text; no {{credentials.*}} support