Domains / Customer Management/ API Endpoint

Workflow API

REST API for defining, triggering, and monitoring automated workflows and business rules.

API Endpoint Application active

Workflow API enables tenants to create and manage automated business workflows. Workflows are defined as sequences of conditions and actions, triggered by domain events or scheduled intervals.

Endpoints

  • GET /api/v1/workflows — List all workflows
  • POST /api/v1/workflows — Create a new workflow
  • PUT /api/v1/workflows/{id} — Update workflow definition
  • POST /api/v1/workflows/{id}/trigger — Manually trigger a workflow
  • GET /api/v1/workflows/{id}/executions — List workflow execution history

Relationships

◇ Composes outgoing 1
Target Element Element Type
Workflow Engine Software Subsystem
◇ Part of incoming 1
Source Element Element Type
Workflow Engine Software Subsystem
→ Served by incoming 11
Source Element Element Type
Anomaly Detected Domain Event
Audit Alert Triggered Domain Event
Bulk Import Completed Domain Event
Contact Created Domain Event
Contact Updated Domain Event
Customer Profile Merged Domain Event
Health Score Changed Domain Event
Incident Declared Domain Event
Onboarding Started Domain Event
Privacy Request Received Domain Event
Workflow Executed Domain Event

Architecture Context

Diagrams

Properties

Type API Endpoint
Layer Application
Domain Customer Management
Status active
Owner Platform Team

Additional Metadata

Protocol REST/JSON
Archimate Type application-interface

Meta Model

Business
Organization
Application current
Technology

Actions