---
title: "Workflow Edges hooks"
description: "Hand-written shim. Implementation is generated; see ./workflow-edges.gen."
section: "Libraries"
group: "React hooks"
order: 472
---

## Hooks

### `useAddWorkflowEdge` `mutation`

Add a workflow edge.

```ts
useAddWorkflowEdge(options?: MutationOpts<WorkflowEdge, AddWorkflowEdgeParams>)
```

**Types:** [WorkflowEdge](/types/workflow-edge) · [AddWorkflowEdgeParams](/types/add-workflow-edge-params)

### `useListWorkflowEdges` `query`

List workflow edges.

```ts
useListWorkflowEdges(params?: Omit<ListWorkflowEdgesParams, | > & { filter?: WorkflowEdgeFilter; orderBy?: WorkflowEdgeOrderBy[]; } & WorkflowEdgeShorthands, options?: QueryOpts<Page<WorkflowEdge>>)
```

**Types:** [ListWorkflowEdgesParams](/types/list-workflow-edges-params) · [WorkflowEdgeFilter](/types/workflow-edge-filter) · [WorkflowEdgeOrderBy](/types/workflow-edge-order-by) · [WorkflowEdgeShorthands](/types/workflow-edge-shorthands) · [Page](/types/page) · [WorkflowEdge](/types/workflow-edge)

### `useRemoveWorkflowEdge` `mutation`

Delete a workflow edge.

```ts
useRemoveWorkflowEdge(options?: MutationOpts<SuccessResponse, DeleteWorkflowEdgeParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [DeleteWorkflowEdgeParams](/types/delete-workflow-edge-params)

### `useRetrieveWorkflowEdge` `query`

Get a workflow edge by ID.

```ts
useRetrieveWorkflowEdge(id: string, options?: QueryOpts<WorkflowEdge>)
```

**Types:** [WorkflowEdge](/types/workflow-edge)

### `useUpdateWorkflowEdge` `mutation`

Update a workflow edge.

```ts
useUpdateWorkflowEdge(options?: MutationOpts<WorkflowEdge, UpdateWorkflowEdgeParams>)
```

**Types:** [WorkflowEdge](/types/workflow-edge) · [UpdateWorkflowEdgeParams](/types/update-workflow-edge-params)