Alur Kerja
Platform Intiworkflow_definitions_readAlur KerjaMembaca otomatisasi workflow fasilitas: daftar workflow, graf lengkap satu workflow, jenis node yang dapat digunakan graf, dan template pilihan. Baca node_types sebelum membuat atau mengedit graf agar setiap jenis dan parameter valid di fasilitas.
Aksi:
- list: Mencantumkan workflow. Setiap workflow beserta status live, versi terbitan, jumlah eksekusi, eksekusi terakhir, dan node-nya (id, name, type). Workflow merek dan organisasi tidak dicantumkan.
- get: Mengambil workflow. Graf draf lengkap (node, koneksi, catatan, pengaturan) dan meta: active, publishedVersionId dan, setelah diterbitkan, publishedWorkflow, graf yang sedang live. Hanya workflow fasilitas ini. Memerlukan workflowId.
- node_types: Jenis node. Entri palet dengan type, label, category, outputs (cabang), dan inputSchema, yaitu parameter yang perlu diisi. available bernilai false, beserta alasannya, jika fasilitas tidak memiliki modul yang diperlukan node. Alat MCP muncul sebagai node mcp.
. . - templates: Template. Titik awal untuk otomatisasi umum, dengan risk dan riskNote (apa yang salah jika diterbitkan secara sembarangan), jenis node, modul yang diperlukan, ketersediaan di fasilitas ini, dan graf pratinjau. Ubah template menjadi graf dengan workflow_definitions_write instantiate_template.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
action* | "list" | "get" | "node_types" | "templates" | Tindakan yang akan dilakukan; setiap tindakan dijelaskan dalam deskripsi alat. |
limit | integer | Item per halaman (default 25, maksimal 100) (list, node_types, templates) |
cursor | string | nextCursor dari halaman sebelumnya (list, node_types, templates) |
facilityId | string | ID fasilitas. Opsional jika fasilitas yang terhubung adalah fasilitas yang Anda maksud. |
workflowId | string | ID workflow dari workflow_definitions_read list (get) |
query | string | Kata yang dicari pada type, label, deskripsi, atau istilah pencarian (node_types) |
category | string | Hanya kategori ini: trigger, action, logic atau ai (node_types) |
types | array | Jenis persis yang akan dijelaskan, mis. jenis dalam workflow yang sedang Anda edit. Mencakup jenis yang sudah dihentikan dan tidak lagi ditampilkan di palet; mengabaikan query dan category. (node_types) |
workflow_definitions_writeAlur KerjaMembuat, mengedit, menerbitkan, menghentikan, dan menghapus otomatisasi workflow fasilitas. Alur penyusunan: baca node_types dengan workflow_definitions_read, susun graf (atau mulai dari instantiate_template), buat sebagai draf, coba dengan workflow_runs_write test (disimulasikan), lalu terbitkan. Pengeditan draf tidak pernah mengubah versi live hingga draf diterbitkan.
Aksi:
- create: Membuat workflow. Menyimpan draf baru yang tidak aktif dari graf lengkap dengan setidaknya satu node; name default-nya "Untitled workflow". Masalah validasi dikembalikan dalam errors beserta detail node. Memerlukan nodes.
- update: Menyimpan draf. Mengganti seluruh draf: kirim setiap node dan koneksi, bukan hanya perubahannya. Versi live tetap berjalan hingga Anda menerbitkan. Masalah validasi dikembalikan dalam errors beserta detail node. Memerlukan workflowId, nodes.
- patch_meta: Mengganti nama. Hanya mengubah nama atau deskripsi; graf dan versi live tetap seperti semula. changed bernilai false jika keduanya sudah sesuai. Memerlukan workflowId.
- duplicate: Menduplikasi. Menyalin workflow ke draf baru bernama "
(copy)" dengan id node baru, tidak pernah diterbitkan atau aktif. Workflow asli tidak tersentuh. Memerlukan workflowId. - delete: Menghapus. Menghapus workflow secara permanen: draf, versi terbitan, riwayat eksekusi, dan perutean pemicu. set_active false menghentikannya tetapi tetap menyimpannya; discard_draft hanya mengatur ulang pengeditan draf. Memerlukan workflowId. Meminta konfirmasi.
- discard_draft: Membuang pengeditan draf. Mengatur ulang draf ke versi terbitan terakhir, membuang pengeditan sejak saat itu. Versi live tidak pernah terpengaruh; memerlukan versi terbitan. Memerlukan workflowId. Meminta konfirmasi.
- publish: Menerbitkan. Memvalidasi draf, menyimpannya sebagai versi live, dan mengaktifkan workflow, sehingga pemicunya berjalan dan aksinya dijalankan secara nyata. Eksekusi yang sedang berlangsung selesai pada versi lama. Jika langkah Delay yang sedang menunggu akan dijadwalkan ulang, hasilnya memiliki kode WAIT_RETARGET_CONFIRMATION_REQUIRED dan impacts: panggil lagi dengan confirmWaitRetargets dan impacts tersebut. Memerlukan workflowId. Meminta konfirmasi.
- set_active: Mengaktifkan atau menonaktifkan. active true mengaktifkan kembali workflow yang telah diterbitkan. active false menghentikannya: pemicu berhenti berjalan dan langkah Delay yang tertunda dibatalkan sehingga tidak pernah selesai. Tidak ada yang dihapus. Meminta konfirmasi terlebih dahulu kecuali sudah dalam status tersebut. Memerlukan workflowId, active. Dapat meminta konfirmasi.
- instantiate_template: Graf dari template. Mengubah template menjadi graf yang siap untuk create: { name, description, nodes, connections } dengan id node baru. Template sengaja mengosongkan penerima, pintu, dan waktu; isi terlebih dahulu. Tidak menyimpan apa pun. Memerlukan templateId.
- generate: Menghasilkan graf. Menyusun graf dari prompt dalam bahasa sederhana dengan AI fasilitas dan mengembalikan { name, description, nodes, connections } yang hanya menggunakan jenis node yang valid. Kirim workflow untuk merevisi workflow yang ada; graf hasil revisi lengkap akan dikembalikan. Tidak menyimpan apa pun, tetapi menggunakan kredit AI fasilitas. Memerlukan prompt. Meminta konfirmasi.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
action* | "create" | "update" | "patch_meta" | "duplicate" | "delete" | "discard_draft" | "publish" | "set_active" | "instantiate_template" | "generate" | Tindakan yang akan dilakukan; setiap tindakan dijelaskan dalam deskripsi alat. |
name | string | Nama workflow (create, update, patch_meta) |
description | string | Apa yang dilakukan workflow (create, update, patch_meta) |
nodes | array | Setiap node: { id, name, type, position, parameters }. Jenis dan parameter berasal dari workflow_definitions_read node_types. (create, update) |
connections | object | Koneksi dengan kunci nama node sumber; boleh kosong untuk satu node (create, update) |
notes | array | Catatan kanvas (create, update) |
settings | object | Pengaturan workflow (create, update) |
facilityId | string | ID fasilitas. Opsional jika fasilitas yang terhubung adalah fasilitas yang Anda maksud. |
workflowId | string | ID workflow dari workflow_definitions_read list (update, patch_meta, duplicate, delete, discard_draft, publish, set_active) |
confirmWaitRetargets | boolean | Jadwalkan ulang langkah Delay yang sedang menunggu yang tercantum dalam impacts hasil sebelumnya (publish) |
confirmedWaitRetargets | array | impacts dari hasil WAIT_RETARGET_CONFIRMATION_REQUIRED, dikirim kembali tanpa perubahan (publish) |
active | boolean | true untuk mengaktifkan, false untuk menghentikan (set_active) |
templateId | string | ID template dari workflow_definitions_read templates (instantiate_template) |
prompt | string | Apa yang harus dilakukan workflow (generate) |
workflow | object | Workflow lengkap dari workflow_definitions_read get, untuk direvisi alih-alih memulai dari awal (generate) |
confirm | boolean | Atur hanya setelah pengguna mengonfirmasi pratinjau yang dikembalikan oleh panggilan pertama |
workflow_runs_readAlur KerjaRiwayat eksekusi workflow, terbaru lebih dulu, dan satu eksekusi langkah demi langkah. Gunakan untuk memeriksa apakah otomatisasi telah berjalan, mengikuti eksekusi yang dimulai dengan workflow_runs_write, atau menemukan node mana yang gagal dan mengapa.
Aksi:
- list: Mencantumkan eksekusi. Setiap eksekusi beserta status, mode (live atau test), efek samping, pemicu, siapa yang memulainya, waktu, jumlah langkah, node yang sedang ditunggu, dan kesalahan apa pun. Memerlukan workflowId.
- get: Mengambil eksekusi. Status eksekusi ditambah setiap langkah secara berurutan, dengan input, output, catatan, dan kesalahan setiap node. Eksekusi bersifat asinkron: eksekusi dengan Delay menunggu hingga kelanjutannya jatuh tempo. Memerlukan workflowId, executionId.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
action* | "list" | "get" | Tindakan yang akan dilakukan; setiap tindakan dijelaskan dalam deskripsi alat. |
workflowId | string | ID workflow dari workflow_definitions_read list |
limit | integer | Item per halaman (default 25, maksimal 100) (list) |
cursor | string | nextCursor dari halaman sebelumnya (list) |
facilityId | string | ID fasilitas. Opsional jika fasilitas yang terhubung adalah fasilitas yang Anda maksud. |
executionId | string | ID eksekusi dari workflow_runs_read list (get) |
workflow_runs_writeAlur KerjaMemulai, menguji, membatalkan, dan memutar ulang eksekusi workflow. Utamakan test, yang menjalankan draf dengan efek samping yang disimulasikan; run mengeksekusi workflow terbitan secara nyata. Eksekusi bersifat asinkron: ikuti dengan workflow_runs_read get.
Aksi:
- run: Jalankan sekarang. Menjalankan workflow terbitan dari pemicu manualnya (custom.manualTrigger), dengan efek samping nyata. Pemicu terjadwal, webhook, dan peristiwa berjalan dengan sendirinya. Mengembalikan executionId eksekusi dan status pertamanya. Memerlukan workflowId. Meminta konfirmasi.
- test: Menguji draf. Menjalankan draf yang tersimpan tanpa menerbitkannya, dicatat sebagai eksekusi uji. Efek samping disimulasikan secara default: tidak ada yang dikirim atau dialihkan, dan setiap node melaporkan apa yang akan dilakukannya. sideEffects live meminta konfirmasi terlebih dahulu. Memerlukan workflowId. Dapat meminta konfirmasi.
- cancel: Membatalkan eksekusi yang menunggu. Membatalkan eksekusi yang sedang menunggu Delay: penantian yang tertunda ditutup dan langkah setelahnya tidak pernah dijalankan. Eksekusi yang sudah selesai dan eksekusi yang sedang di tengah langkah tidak dapat dibatalkan. Memerlukan workflowId, executionId. Meminta konfirmasi.
- retry: Memutar ulang eksekusi. Memutar ulang eksekusi yang sudah selesai dari input pemicu yang tercatat, ditautkan kembali melalui retryOf. published (default) menjalankan ulang versi yang digunakannya, secara nyata, dan meminta konfirmasi terlebih dahulu; draft-test menjalankan draf saat ini secara simulasi, pilihan yang tepat saat memperbaiki kegagalan. Memerlukan workflowId, executionId. Dapat meminta konfirmasi.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
action* | "run" | "test" | "cancel" | "retry" | Tindakan yang akan dilakukan; setiap tindakan dijelaskan dalam deskripsi alat. |
workflowId | string | ID workflow dari workflow_definitions_read list |
nodeId | string | ID node pemicu untuk memulai; jangan sertakan untuk pemicu manual (run, test) |
payload | object | Input untuk node setelah pemicu, mis. { "visitorName": "Ada" } (run, test) |
facilityId | string | ID fasilitas. Opsional jika fasilitas yang terhubung adalah fasilitas yang Anda maksud. |
sideEffects | "simulate" | "live" | Apakah aksi node benar-benar dijalankan (test) |
executionId | string | ID eksekusi dari workflow_runs_read list (cancel, retry) |
mode | "published" | "draft-test" | Terhadap apa pemutaran ulang dilakukan (retry) |
confirm | boolean | Atur hanya setelah pengguna mengonfirmasi pratinjau yang dikembalikan oleh panggilan pertama |