Skip to main content

Workflow Message Contract Catalog

Audience

Developers, QA, support, architects and integration reviewers.

Summary

This catalog inventories exactly six Workflow-specific message contracts. All inherit the shared envelope and use schema version 1 when mapped.

Shared envelope

Every contract carries event identity/type/time, optional correlation/causation, optional shared tenant/user identity, source service and schema version. Workflow mapping sets numeric tenancy in contract payload rather than the shared tenant field.

Reference Content

#ContractPurposeWorkflow payloadVersionCompatibilityValidation
1WorkflowStartedEventAnnounce instance startNumeric tenant, instance/definition/key, subject, initiator1Native onlyTyped construction; no schema validator
2WorkflowTaskCreatedEventAnnounce task creationNumeric tenant, instance/task/key, stage/name/type, assignment1Native onlyTyped construction; no schema validator
3WorkflowTaskApprovedEventAnnounce task approvalNumeric tenant, instance/task/key, stage, actor1Native onlyTyped construction; no schema validator
4WorkflowTaskRejectedEventAnnounce task rejectionNumeric tenant, instance/task/key, stage, actor, optional reason1Native onlyTyped construction; no schema validator
5WorkflowCompletedEventAnnounce approved completionNumeric tenant, instance/key and subject1Native onlyTyped construction; no schema validator
6WorkflowRejectedEventAnnounce rejected instanceNumeric tenant, instance/key, subject, actor, optional reason1Native onlyTyped construction; no schema validator

Serialization

Shared JSON serialization uses web defaults, omits null values and serializes using each concrete runtime record type.

Requires Confirmation

Schema governance, backward compatibility, registry/publication and payload validation require confirmation.

Source References

  • microservices/src/workflow-service/Messaging/WorkflowIntegrationEvents.cs
  • microservices/src/contracts/Events/IntegrationEvent.cs
  • microservices/src/shared-kernel/Outbox/IntegrationEventJsonSerializer.cs

See Also

Keywords

Workflow events, integration contracts, transactional outbox.

Revision Information

  • Status: Draft
  • Last reviewed: 2026-07-20
  • Next review: 2026-10-20