ConnectCloud Developers

Check the workflow setup of the tenant (tenant:settings:write)

POST /api/workflow/v1/config/validate

Module: Workflow · operationId: validateWorkflowConfig · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)

Runs live checks (database, stored configuration, trade connection, HR connection, blueprints, comms) and reports each one. Changes nothing; ok is false when a check has status error. Sends no request body.

Responses

  • 200 Check results (application/json)
  • 401 Missing or invalid token (unauthorized) (application/json)
  • 403 Error (application/json)

Fields of the 200 answer:

  • checks (array of object): One entry per check
    • detail (string): Details of the outcome
    • label (string): Name of the check
    • status (string): Outcome of the check (one of success, warning, error, neutral)
  • message (string): Summary of the check
  • ok (boolean): False when any check has status error

Example 200 answer:

{
  "checks": [
    {
      "detail": "Verbindung zu trade erfolgreich.",
      "label": "trade-Verbindung",
      "status": "success"
    },
    {
      "detail": "Alle Gruppen der Blueprints gibt es.",
      "label": "HR-Gruppen",
      "status": "success"
    },
    {
      "detail": "Kein Blueprint nutzt einen Teams-Kanal.",
      "label": "Benachrichtigungen",
      "status": "neutral"
    }
  ],
  "message": "Konfiguration ist gültig.",
  "ok": true
}

Example request

curl -X POST 'https://api.mbcom.cloud/api/workflow/v1/config/validate' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI