---
title: "Builds hooks"
description: "Hand-written shim. Generated list+get via ./builds.gen.
useCancelBuild stays hand-written."
section: "Libraries"
group: "React hooks"
order: 407
---

## Hooks

### `useCancelBuild` `composite`

```ts
useCancelBuild(options?: MutationOpts<SuccessResponse, CancelBuildParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [CancelBuildParams](/types/cancel-build-params)

### `useCreateBuild` `mutation`

Trigger a build.

```ts
useCreateBuild(options?: MutationOpts<Build, CreateBuildParams>)
```

**Types:** [Build](/types/build) · [CreateBuildParams](/types/create-build-params)

### `useListBuilds` `query`

List builds.

```ts
useListBuilds(params?: Omit<ListBuildsParams, | > & { filter?: BuildFilter; orderBy?: BuildOrderBy[]; } & BuildShorthands, options?: QueryOpts<Page<Build>>)
```

**Types:** [ListBuildsParams](/types/list-builds-params) · [BuildFilter](/types/build-filter) · [BuildOrderBy](/types/build-order-by) · [BuildShorthands](/types/build-shorthands) · [Page](/types/page) · [Build](/types/build)

### `useRetrieveBuild` `query`

Get a build by ID, including its step list.

```ts
useRetrieveBuild(id: string, options?: QueryOpts<BuildWithSteps>)
```

**Types:** [BuildWithSteps](/types/build-with-steps)