Integration Hub — API and MCP
Overview
This area exposes 45 operations. Each of them is at the same time an MCP tool.
This area is behind the module switch module.connect. With the module off, these operations answer 404.
Operations
| Method | Path | Purpose | Permission | Parameters |
|---|---|---|---|---|
GET | /api/v1/connect/auth-methods | Retrieves the collection of ConnectAuthMethod resources. — Alle verfügbaren Anmelde-Arten für ausgehende Aufrufe mit ihren Konfigurationsfeldern und den erwarteten Geheimnis-Schlüsseln. | connect.flow.view · connect.flow.manage | — |
GET | /api/v1/connect/flows | Collection of ConnectFlow | connect.flow.view · connect.flow.manage | page, active, triggerType, q |
POST | /api/v1/connect/flows | Creates a ConnectFlow resource. — Legt einen Flow an. nodes beschreibt den Bauplan; jeder Baustein braucht nodeKey, type und label. Ein Flow wird INAKTIV angelegt — aktiv wird er erst über activate, und das prüft ihn. | connect.flow.manage | + body |
POST | /api/v1/connect/flows/import | Creates a ConnectFlow resource. — Liest ein Bündel ein. IDEMPOTENT über flowKey: zweimal dasselbe Bündel ergibt denselben Zustand, nicht zwei Flows. Der Flow entsteht bzw. bleibt INAKTIV. Optional flowKey als abweichender Zielschlüssel (Kopie). | connect.flow.manage | + body |
POST | /api/v1/connect/flows/run-scheduled | Fällige Zeitplan- und Abruf-Flows jetzt starten — Fährt EINEN Durchgang über alles Fällige — genau den, den der Minuten-Tick des Systems fährt (Zeitplan-Flows nach Cron-Ausdruck, Abruf-Flows nach Takt und Wasserstand). Ohne diesen Weg wäre die Kernfähigkeit des Hubs nur über die Konsole erreichbar. Antwort: startedFlowKeys. Geschnitten wird an connect.flow.execute JE MARKE — ein fälliger Flow einer fremden Marke bleibt stehen. | connect.flow.execute | + body |
DELETE | /api/v1/connect/flows/{ulid} | Delete a ConnectFlow | connect.flow.manage | ulid |
GET | /api/v1/connect/flows/{ulid} | Read one ConnectFlow | connect.flow.view · connect.flow.manage | ulid |
PATCH | /api/v1/connect/flows/{ulid} | Updates the ConnectFlow resource. — Ändert einen Flow. Mitgesendete nodes ERSETZEN den Bauplan vollständig. | connect.flow.manage | ulid, + body |
POST | /api/v1/connect/flows/{ulid}/activate | Activate flow — Activate flow. Dedicated action endpoint — not a standard CRUD create. | connect.flow.manage | ulid, + body |
POST | /api/v1/connect/flows/{ulid}/deactivate | Deactivate flow — Deactivate flow. Dedicated action endpoint — not a standard CRUD create. | connect.flow.manage | ulid, + body |
GET | /api/v1/connect/flows/{ulid}/export | Retrieves a ConnectFlow resource. — Exportiert den Flow als Bündel (bundle) inklusive der benutzten Zuordnungen und Zuordnungstabellen. OHNE Webhook-Geheimnis, ohne ausführenden Benutzer, ohne Marke — die sind installations-eigen bzw. geheim. bundle.requiredFlows nennt Unter-Flows, die das Bündel NICHT mitbringt. | connect.flow.manage | ulid |
POST | /api/v1/connect/flows/{ulid}/nodes | Einzelnen Baustein an den Flow anhängen — Fügt EINEN Baustein hinzu, ohne den übrigen Bauplan zu senden. Feld node wie ein Eintrag in nodes; optional after (Baustein-Schlüssel) für die Verbindung davor. | connect.flow.manage | ulid, + body |
DELETE | /api/v1/connect/flows/{ulid}/nodes/{nodeKey} | Removes the ConnectFlow resource. — Entfernt EINEN Baustein samt seiner Verbindungen. | connect.flow.manage | ulid, nodeKey |
PATCH | /api/v1/connect/flows/{ulid}/nodes/{nodeKey} | Updates the ConnectFlow resource. — Ändert EINEN Baustein. Nur die gesendeten Felder von node werden übernommen — der übrige Bauplan bleibt unangetastet. | connect.flow.manage | ulid, nodeKey, + body |
POST | /api/v1/connect/flows/{ulid}/run | Flow asynchron starten — Startet den Flow ASYNCHRON über die Queue. Nur bei aktivem Flow. | connect.flow.execute | ulid, + body |
POST | /api/v1/connect/flows/{ulid}/test | Flow synchron testen — Testlauf: SYNCHRON, ohne Queue, mit dem mitgegebenen payload als {{trigger}}. Erzeugt einen echten Lauf samt Journal — ein Testlauf ohne Journal hätte den halben Nutzen. Läuft auch bei inaktivem Flow. | connect.flow.execute | ulid, + body |
POST | /api/v1/connect/flows/{ulid}/test-until/{nodeKey} | Creates a ConnectFlow resource. — Testlauf BIS EINSCHLIESSLICH eines Bausteins — der Rest der Kette bleibt stehen. Beim Bauen der Unterschied zwischen Probieren und Auslösen: der Versand dahinter passiert nicht. | connect.flow.execute | ulid, nodeKey, + body |
POST | /api/v1/connect/flows/{ulid}/validate | Bauplan des Flows prüfen — Prüft den Bauplan, ohne ihn zu ändern: Trigger vollständig, Baustein-Typen bekannt, Schlüssel eindeutig, Pflichtfelder gesetzt. Antwort: valid + errors. | connect.flow.view · connect.flow.manage | ulid, + body |
GET | /api/v1/connect/flows/{ulid}/versions | Collection of ConnectFlowVersion | connect.flow.view · connect.flow.manage | ulid |
GET | /api/v1/connect/flows/{ulid}/versions/{versionNo} | Retrieves a ConnectFlowVersion resource. — Eine Fassung mit vollständigem Bauplan-Schnappschuss — dieselbe Form wie ein Export-Bündel. | connect.flow.view · connect.flow.manage | ulid, versionNo |
POST | /api/v1/connect/flows/{ulid}/versions/{versionNo}/restore | Restore version — Restore version. Dedicated action endpoint — not a standard CRUD create. | connect.flow.manage | ulid, versionNo, + body |
GET | /api/v1/connect/lookup-tables | Collection of ConnectLookupTable | connect.flow.view · connect.flow.manage | page, q |
POST | /api/v1/connect/lookup-tables | Creates a ConnectLookupTable resource. — strict=true macht einen unbekannten Fremdwert zum Fehler statt ihn durchzureichen — genau der Unterschied, der Bestellungen mit unbekannter Zahlart auffallen lässt. | connect.flow.manage | + body |
DELETE | /api/v1/connect/lookup-tables/{ulid} | Delete a ConnectLookupTable | connect.flow.manage | ulid |
GET | /api/v1/connect/lookup-tables/{ulid} | Read one ConnectLookupTable | connect.flow.view · connect.flow.manage | ulid |
PATCH | /api/v1/connect/lookup-tables/{ulid} | Update a ConnectLookupTable | connect.flow.manage | ulid, + body |
GET | /api/v1/connect/mappings | Collection of ConnectMapping | connect.flow.view · connect.flow.manage | page, q |
POST | /api/v1/connect/mappings | Creates a ConnectMapping resource. — Legt eine Zuordnung an. Je Regel: target (Punkt-Pfad in der Zielstruktur, items.0.sku legt Listen an), source (Ausdruck gegen {{source.…}}), optional default, required, lookup. | connect.flow.manage | + body |
DELETE | /api/v1/connect/mappings/{ulid} | Delete a ConnectMapping | connect.flow.manage | ulid |
GET | /api/v1/connect/mappings/{ulid} | Read one ConnectMapping | connect.flow.view · connect.flow.manage | ulid |
PATCH | /api/v1/connect/mappings/{ulid} | Update a ConnectMapping | connect.flow.manage | ulid, + body |
POST | /api/v1/connect/mappings/{ulid}/preview | Feld-Zuordnung an einer Payload vorschauen — Wendet die Zuordnung auf eine Payload an, ohne etwas zu ändern — source aus dem Aufruf, sonst die hinterlegte Beispiel-Payload. Antwort: result bzw. errors. | connect.flow.view · connect.flow.manage | ulid, + body |
GET | /api/v1/connect/node-groups | Retrieves the collection of ConnectNodeGroup resources. — Alle Baustein-Gruppen mit Hausfarbe, Symbol und Bildmarke. Eine Gruppe ist ein System („Shopware", „DHL", „Octibiz · Verkauf"). Gruppen deaktivierter Plugins fehlen hier. | connect.flow.view · connect.flow.manage | — |
GET | /api/v1/connect/node-types | Retrieves the collection of ConnectNodeType resources. — Alle verfügbaren Baustein-Typen mit ihren Konfigurationsfeldern. Beiträge deaktivierter Plugins fehlen hier — ein abgeschalteter Konnektor darf nicht baubar aussehen. | connect.flow.view · connect.flow.manage | — |
GET | /api/v1/connect/runs | Collection of ConnectRun | connect.run.view | page, flowUlid, flowKey, status, triggerSource, order[startedAt], order[finishedAt], order[createdAt], order[status], order[triggerSource] |
GET | /api/v1/connect/runs/{ulid} | Retrieves a ConnectRun resource. — Ein Lauf mit allen Schritten — je Schritt Eingang, Ausgang, Fehler, Versuche und Dauer. Payloads über 65.000 Zeichen sind sichtbar gekürzt. | connect.run.view | ulid |
POST | /api/v1/connect/runs/{ulid}/cancel | Cancel run — Cancel run. Dedicated action endpoint — not a standard CRUD create. | connect.flow.execute | ulid, + body |
POST | /api/v1/connect/runs/{ulid}/retry | Gescheiterten Lauf ab der Fehlerstelle wiederholen — Lässt EINEN gescheiterten Lauf erneut laufen — AB DER FEHLERSTELLE, mit den Datensätzen der bereits gelaufenen Bausteine. Was in Fremdsystemen schon angelegt wurde, entsteht damit kein zweites Mal. | connect.flow.execute | ulid, + body |
GET | /api/v1/connect/store | Collection of ConnectStore | connect.flow.view · connect.flow.manage | page, q, flowUlid, global |
DELETE | /api/v1/connect/store/{ulid} | Removes the ConnectStore resource. — Vergisst den Wert. Ein gelöschter Wasserstand heisst beim nächsten Abruf: von vorn. | connect.flow.manage | ulid |
GET | /api/v1/connect/store/{ulid} | Read one ConnectStore | connect.flow.view · connect.flow.manage | ulid |
PATCH | /api/v1/connect/store/{ulid} | Updates the ConnectStore resource. — Setzt den gemerkten Wert. Der übliche Griff: einen Wasserstand zurückdrehen, damit der nächste Abruf ein älteres Fenster noch einmal holt. | connect.flow.manage | ulid, + body |
GET | /api/v1/connect/templates | Retrieves the collection of ConnectTemplate resources. — Alle verfügbaren Flow-Vorlagen mit ihren Parametern. Vorlagen deaktivierter Plugins fehlen hier. | connect.flow.view · connect.flow.manage | — |
POST | /api/v1/connect/templates/{key}/install | Install template — Install template. Dedicated action endpoint — not a standard CRUD create. | connect.flow.manage | key, + body |
GET | /api/v1/connect/webhook-schemes | Retrieves the collection of ConnectWebhookScheme resources. — Alle verfügbaren Signatur-Verfahren für eingehende Webhooks. Beiträge deaktivierter Plugins fehlen hier. | connect.flow.view · connect.flow.manage | — |
Purpose texts that do not follow the standard pattern are taken verbatim from the interface description in the code.