AeontelAeontel Docs

Workflow Nodes hooks

Hand-written shim. Implementation is generated; see ./workflow-nodes.gen.

Hooks

useAddWorkflowNode mutation

Add a workflow node.

TypeScript
useAddWorkflowNode(options?: MutationOpts<WorkflowNode, AddWorkflowNodeParams>)

Types: WorkflowNode · AddWorkflowNodeParams

useListWorkflowNodes query

List workflow nodes.

TypeScript
useListWorkflowNodes(params?: Omit<ListWorkflowNodesParams, | > & { filter?: WorkflowNodeFilter; orderBy?: WorkflowNodeOrderBy[]; } & WorkflowNodeShorthands, options?: QueryOpts<Page<WorkflowNode>>)

Types: ListWorkflowNodesParams · WorkflowNodeFilter · WorkflowNodeOrderBy · WorkflowNodeShorthands · Page · WorkflowNode

useRemoveWorkflowNode mutation

Delete a workflow node.

TypeScript
useRemoveWorkflowNode(options?: MutationOpts<SuccessResponse, DeleteWorkflowNodeParams>)

Types: SuccessResponse · DeleteWorkflowNodeParams

useRetrieveWorkflowNode query

Get a workflow node by ID.

TypeScript
useRetrieveWorkflowNode(id: string, options?: QueryOpts<WorkflowNode>)

Types: WorkflowNode

useUpdateWorkflowNode mutation

Update a workflow node.

TypeScript
useUpdateWorkflowNode(options?: MutationOpts<WorkflowNode, UpdateWorkflowNodeParams>)

Types: WorkflowNode · UpdateWorkflowNodeParams