Workworkflows
Kernplatformworkflow_definitions_readWorkworkflowsLeest de workflowautomatiseringen van een faciliteit: de workflows, de volledige graaf van één workflow, de nodetypen die een graaf kan gebruiken, en geselecteerde templates. Lees node_types voordat je een graaf bouwt of bewerkt, zodat elk type en elke parameter bij de faciliteit geldig is.
Acties:
- list: Workflows weergeven. Elke workflow met of hij live is, de gepubliceerde versie, het aantal runs, de laatste run en de nodes (id, name, type). Workflows van een merk of organisatie worden niet getoond.
- get: Workflow ophalen. De volledige conceptgraaf (nodes, connections, notes, settings) en meta: active, publishedVersionId en, na publicatie, publishedWorkflow, de graaf die nu live is. Alleen workflows van deze faciliteit. Vereist workflowId.
- node_types: Nodetypen. Paletitems met type, label, categorie, outputs (vertakkingen) en inputSchema, de in te vullen parameters. available is false, met de reden, als de faciliteit een module mist die de node nodig heeft. MCP-tools verschijnen als mcp.
. -nodes. - templates: Templates. Startpunten voor veelvoorkomende automatiseringen, met risk en riskNote (wat er misgaat bij onzorgvuldig publiceren), nodetypen, vereiste modules, beschikbaarheid bij deze faciliteit en een voorbeeldgraaf. Zet er een om in een graaf met workflow_definitions_write instantiate_template.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "list" | "get" | "node_types" | "templates" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
limit | integer | Items per pagina (standaard 25, maximaal 100) (list, node_types, templates) |
cursor | string | nextCursor van de vorige pagina (list, node_types, templates) |
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. |
workflowId | string | Workflow-id uit workflow_definitions_read list (get) |
query | string | Woorden om te zoeken in het type, label, de beschrijving of zoektermen (node_types) |
category | string | Alleen deze categorie: trigger, action, logic of ai (node_types) |
types | array | Exacte typen om te beschrijven, bijv. die in een workflow die je bewerkt. Omvat ook vervallen typen die het palet niet meer toont; negeert query en category. (node_types) |
workflow_definitions_writeWorkworkflowsMaakt de workflowautomatiseringen van een faciliteit aan, bewerkt, publiceert, stopt en verwijdert ze. Werkwijze: lees node_types met workflow_definitions_read, bouw de graaf (of begin met instantiate_template), maak hem aan als concept, probeer hem uit met workflow_runs_write test (gesimuleerd) en publiceer hem dan. Bewerkingen van een concept veranderen nooit wat live is, totdat het wordt gepubliceerd.
Acties:
- create: Workflow aanmaken. Slaat een nieuw, inactief concept op vanuit een volledige graaf met ten minste één node; name is standaard "Untitled workflow". Validatieproblemen komen terug in errors met details per node. Vereist nodes.
- update: Concept opslaan. Vervangt het hele concept: stuur elke node en elke verbinding mee, niet alleen de wijzigingen. Wat live is, blijft draaien totdat je publiceert. Validatieproblemen komen terug in errors met details per node. Vereist workflowId, nodes.
- patch_meta: Hernoemen. Wijzigt alleen de naam of beschrijving; de graaf en wat live is blijven ongewijzigd. changed is false als beide al overeenkomen. Vereist workflowId.
- duplicate: Dupliceren. Kopieert een workflow naar een nieuw concept met de naam "
(copy)" en nieuwe node-id's, nooit gepubliceerd of actief. Het origineel blijft ongewijzigd. Vereist workflowId. - delete: Verwijderen. Verwijdert de workflow definitief: concept, gepubliceerde versies, rungeschiedenis en triggerroutering. set_active false stopt hem maar bewaart hem; discard_draft zet alleen conceptbewerkingen terug. Vereist workflowId. Vraagt om bevestiging.
- discard_draft: Conceptbewerkingen verwerpen. Zet het concept terug naar de laatst gepubliceerde versie en gooit sindsdien gemaakte bewerkingen weg. De live versie wordt nooit beïnvloed; vereist een gepubliceerde versie. Vereist workflowId. Vraagt om bevestiging.
- publish: Publiceren. Valideert het concept, slaat het op als de live versie en zet de workflow aan, zodat de triggers afgaan en de acties echt worden uitgevoerd. Lopende runs worden afgerond op de oude versie. Als wachtende Delay-stappen een nieuwe timing zouden krijgen, heeft het resultaat code WAIT_RETARGET_CONFIRMATION_REQUIRED en impacts: roep opnieuw aan met confirmWaitRetargets en die impacts. Vereist workflowId. Vraagt om bevestiging.
- set_active: Aan- of uitzetten. active true zet een gepubliceerde workflow weer aan. active false stopt hem: triggers gaan niet meer af en openstaande Delay-stappen worden geannuleerd, zodat ze nooit worden afgerond. Er wordt niets verwijderd. Vraagt eerst om bevestiging, tenzij hij al in die status is. Vereist workflowId, active. Kan om bevestiging vragen.
- instantiate_template: Graaf uit template. Zet een template om in een graaf die klaar is voor create: { name, description, nodes, connections } met nieuwe node-id's. Templates laten ontvangers, deuren en tijden bewust leeg; vul die eerst in. Slaat niets op. Vereist templateId.
- generate: Graaf genereren. Bouwt een graaf op basis van een prompt in gewone taal met de AI van de faciliteit en retourneert { name, description, nodes, connections } met alleen geldige nodetypen. Geef workflow mee om er een te herzien; de volledige herziene graaf komt terug. Slaat niets op, maar verbruikt AI-tegoed van de faciliteit. Vereist prompt. Vraagt om bevestiging.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "create" | "update" | "patch_meta" | "duplicate" | "delete" | "discard_draft" | "publish" | "set_active" | "instantiate_template" | "generate" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
name | string | Naam van de workflow (create, update, patch_meta) |
description | string | Wat de workflow doet (create, update, patch_meta) |
nodes | array | Elke node: { id, name, type, position, parameters }. Typen en parameters komen uit workflow_definitions_read node_types. (create, update) |
connections | object | Verbindingen met de naam van de bronnode als sleutel; mag leeg zijn bij één node (create, update) |
notes | array | Notities op het canvas (create, update) |
settings | object | Instellingen van de workflow (create, update) |
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. |
workflowId | string | Workflow-id uit workflow_definitions_read list (update, patch_meta, duplicate, delete, discard_draft, publish, set_active) |
confirmWaitRetargets | boolean | De wachtende Delay-stappen uit de impacts van het vorige resultaat opnieuw timen (publish) |
confirmedWaitRetargets | array | De impacts uit het resultaat WAIT_RETARGET_CONFIRMATION_REQUIRED, ongewijzigd teruggestuurd (publish) |
active | boolean | true om hem aan te zetten, false om hem te stoppen (set_active) |
templateId | string | Template-id uit workflow_definitions_read templates (instantiate_template) |
prompt | string | Wat de workflow moet doen (generate) |
workflow | object | Een volledige workflow uit workflow_definitions_read get, om te herzien in plaats van opnieuw te beginnen (generate) |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |
workflow_runs_readWorkworkflowsDe rungeschiedenis van een workflow, nieuwste eerst, en één run stap voor stap. Gebruik dit om te controleren of een automatisering is uitgevoerd, een run te volgen die met workflow_runs_write is gestart, of te vinden welke node is mislukt en waarom.
Acties:
- list: Runs weergeven. Elke run met status, modus (live of test), neveneffecten, trigger, wie hem startte, tijden, aantal stappen, de node waarop hij wacht en eventuele fouten. Vereist workflowId.
- get: Run ophalen. De status van de run plus elke stap op volgorde, met de input, output, notitie en fout van elke node. Runs zijn asynchroon: een run met Delays wacht totdat het vervolg aan de beurt is. Vereist workflowId, executionId.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "list" | "get" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
workflowId | string | Workflow-id uit workflow_definitions_read list |
limit | integer | Items per pagina (standaard 25, maximaal 100) (list) |
cursor | string | nextCursor van de vorige pagina (list) |
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. |
executionId | string | Run-id uit workflow_runs_read list (get) |
workflow_runs_writeWorkworkflowsStart, test, annuleert en herhaalt workflowruns. Gebruik bij voorkeur test, dat het concept uitvoert met gesimuleerde neveneffecten; run voert de gepubliceerde workflow echt uit. Runs zijn asynchroon: volg ze met workflow_runs_read get.
Acties:
- run: Nu uitvoeren. Voert de gepubliceerde workflow uit vanaf de handmatige trigger (custom.manualTrigger), met echte neveneffecten. Geplande triggers, webhooktriggers en eventtriggers gaan vanzelf af. Retourneert de executionId en eerste status van de run. Vereist workflowId. Vraagt om bevestiging.
- test: Concept testen. Voert het opgeslagen concept uit zonder het te publiceren, vastgelegd als testrun. Neveneffecten worden standaard gesimuleerd: er wordt niets verstuurd of geschakeld, en elke node meldt wat hij zou hebben gedaan. sideEffects live vraagt eerst om bevestiging. Vereist workflowId. Kan om bevestiging vragen.
- cancel: Wachtende run annuleren. Annuleert een run die op een Delay wacht: de openstaande wachttijden worden gesloten en de stappen daarna worden nooit uitgevoerd. Afgeronde runs en runs midden in een stap kunnen niet worden geannuleerd. Vereist workflowId, executionId. Vraagt om bevestiging.
- retry: Run herhalen. Herhaalt een afgeronde run op basis van de vastgelegde triggerinput, terug gekoppeld via retryOf. published (standaard) voert de gebruikte versie opnieuw echt uit en vraagt eerst om bevestiging; draft-test voert het huidige concept gesimuleerd uit, de juiste keuze terwijl je een fout oplost. Vereist workflowId, executionId. Kan om bevestiging vragen.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "run" | "test" | "cancel" | "retry" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
workflowId | string | Workflow-id uit workflow_definitions_read list |
nodeId | string | Trigger-node-id om vanaf te starten; weglaten voor de handmatige trigger (run, test) |
payload | object | Input voor de nodes na de trigger, bijv. { "visitorName": "Ada" } (run, test) |
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. |
sideEffects | "simulate" | "live" | Of de acties van nodes echt worden uitgevoerd (test) |
executionId | string | Run-id uit workflow_runs_read list (cancel, retry) |
mode | "published" | "draft-test" | Waartegen de herhaling wordt uitgevoerd (retry) |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |