Chuyển đến nội dung

Workflows

client.workflows hiển thị cả tự động hóa kênh (route v2/backend) và công cụ flow (CRUD flows, runs, folders, connections, pieces, MCP servers, tables, invitations).

Khởi tạo client trước (xem Cài đặt hoặc Quick Start). Để biết hướng dẫn từ đầu đến cuối kết nối workflow với AI agent, xem Hướng dẫn toàn diện §2.

Tự động hóa Kênh — `client.workflows`

TypeScript
Python

const { data: automations }    = await client.workflows.listChannelAutomation();
const { data: whatsappFlows }  = await client.workflows.listChannelAutomation({ channelType: "whatsapp" });

automations    = client.workflows.list_channel_automation().get("data", [])
whatsapp_flows = client.workflows.list_channel_automation(channel_type="whatsapp").get("data", [])

Flows

CRUD

TypeScript
Python

const { data: flows } = await client.workflows.listFlows();

const flow = await client.workflows.getFlow("flow_id");

const newFlow = await client.workflows.createFlow({
  displayName: "New Lead Notification",
  projectId: "project_id",
});

await client.workflows.deleteFlow("flow_id");

flows = client.workflows.list_flows().get("data", [])

flow = client.workflows.get_flow("flow_id")

new_flow = client.workflows.create_flow(
    display_name="New Lead Notification",
    project_id="project_id",
)

client.workflows.delete_flow("flow_id")

Áp dụng thao tác

TypeScript
Python

await client.workflows.applyFlowOperation("flow_id", {
  type: "UPDATE_TRIGGER",
  request: {
    name: "trigger",
    type: "PIECE_TRIGGER",
    valid: true,
    displayName: "Webhook",
    settings: {
      pieceName: "@activepieces/piece-webhook",
      pieceVersion: "0.1.24",
      triggerName: "catch_webhook",
      input: {},
      propertySettings: {},
    },
  },
});

client.workflows.apply_flow_operation("flow_id", {
    "type": "UPDATE_TRIGGER",
    "request": {
        "name": "trigger",
        "type": "PIECE_TRIGGER",
        "valid": True,
        "displayName": "Webhook",
        "settings": {
            "pieceName": "@activepieces/piece-webhook",
            "pieceVersion": "0.1.24",
            "triggerName": "catch_webhook",
            "input": {},
            "propertySettings": {},
        },
    },
})

Kích hoạt flow

TypeScript
Python

// Fire and forget
await client.workflows.triggerFlow("flow_id", {
  contactId: "contact_xxx",
  event: "lead_qualified",
});

// Chờ kết quả
const result = await client.workflows.triggerFlowSync("flow_id", {
  contactId: "contact_xxx",
  event: "lead_qualified",
});

# Fire and forget
client.workflows.trigger_flow("flow_id", {"contactId": "contact_xxx", "event": "lead_qualified"})

# Chờ kết quả
result = client.workflows.trigger_flow_sync("flow_id", {"contactId": "contact_xxx", "event": "lead_qualified"})

Lượt chạy Flow

TypeScript
Python

const { data: runs } = await client.workflows.listRuns({ flowId: "flow_id", limit: 20 });
const run            = await client.workflows.getRun("run_id");

runs = client.workflows.list_runs(flow_id="flow_id", limit=20).get("data", [])
run  = client.workflows.get_run("run_id")

Thư mục

TypeScript
Python

const { data: folders }  = await client.workflows.listFolders();
const folder             = await client.workflows.getFolder("folder_id");
const newFolder          = await client.workflows.createFolder({ displayName: "CRM Automations", projectId: "project_id" });
const updated            = await client.workflows.updateFolder("folder_id", { displayName: "Updated Name" });
await client.workflows.deleteFolder("folder_id");

folders    = client.workflows.list_folders().get("data", [])
folder     = client.workflows.get_folder("folder_id")
new_folder = client.workflows.create_folder(display_name="CRM Automations", project_id="project_id")
updated    = client.workflows.update_folder(folder_id="folder_id", display_name="Updated Name")
client.workflows.delete_folder("folder_id")

Kết nối Ứng dụng

TypeScript
Python

const { data: connections } = await client.workflows.listConnections();
const connection            = await client.workflows.getConnection("connection_id");
await client.workflows.upsertConnection({
  name: "slack-integration",
  type: "OAUTH2",
  value: { access_token: "xoxb-xxx" },
});
await client.workflows.deleteConnection("connection_id");

connections = client.workflows.list_connections().get("data", [])
connection  = client.workflows.get_connection("connection_id")
client.workflows.upsert_connection({"name": "slack-integration", "type": "OAUTH2", "value": {"access_token": "xoxb-xxx"}})
client.workflows.delete_connection("connection_id")

Pieces

TypeScript
Python

const pieces = await client.workflows.listPieces({ limit: 20 });

pieces = client.workflows.list_pieces(limit=20)

Triggers

TypeScript
Python

const status = await client.workflows.getTriggerRunStatus();
await client.workflows.testTrigger({ pieceName: "@activepieces/piece-webhook", flowId: "flow_id" });

status = client.workflows.get_trigger_run_status()
client.workflows.test_trigger({"pieceName": "@activepieces/piece-webhook", "flowId": "flow_id"})

Bảng & Bản ghi

TypeScript
Python

const { data: tables }  = await client.workflows.listTables();
const table             = await client.workflows.getTable("table_id");
const { data: records } = await client.workflows.listRecords({ tableId: "table_id" });

tables  = client.workflows.list_tables().get("data", [])
table   = client.workflows.get_table("table_id")
records = client.workflows.list_records(table_id="table_id").get("data", [])

MCP Servers

TypeScript
Python

const { data: servers } = await client.workflows.listMcpServers("project_id");
const server            = await client.workflows.getMcpServer("mcp_server_id");
const newServer         = await client.workflows.createMcpServer({ projectId: "project_id", name: "My MCP" });
await client.workflows.deleteMcpServer("mcp_server_id");
await client.workflows.rotateMcpToken("mcp_server_id");

servers    = client.workflows.list_mcp_servers(project_id="project_id").get("data", [])
server     = client.workflows.get_mcp_server("mcp_server_id")
new_server = client.workflows.create_mcp_server({"projectId": "project_id", "name": "My MCP"})
client.workflows.delete_mcp_server("mcp_server_id")
client.workflows.rotate_mcp_token("mcp_server_id")

Lời mời Người dùng

TypeScript
Python

const { data: invitations } = await client.workflows.listInvitations({ type: "PROJECT" });
await client.workflows.deleteInvitation("invitation_id");

invitations = client.workflows.list_invitations(type="PROJECT").get("data", [])
client.workflows.delete_invitation("invitation_id")