---
title: "Triggers hooks"
description: "Hand-written shim. Implementation is generated; see ./triggers.gen."
section: "Libraries"
group: "React hooks"
order: 462
---

## Hooks

### `useCreateTrigger` `mutation`

Create a trigger.

```ts
useCreateTrigger(options?: MutationOpts<Trigger, CreateTriggerParams>)
```

**Types:** [Trigger](/types/trigger) · [CreateTriggerParams](/types/create-trigger-params)

### `useDeleteTrigger` `mutation`

Soft-delete a trigger.

```ts
useDeleteTrigger(options?: MutationOpts<SuccessResponse, string>)
```

**Types:** [SuccessResponse](/types/success-response)

### `useListTriggers` `query`

List triggers.

```ts
useListTriggers(params?: Omit<ListTriggersParams, | > & { filter?: TriggerFilter; orderBy?: TriggerOrderBy[]; } & TriggerShorthands, options?: QueryOpts<Page<Trigger>>)
```

**Types:** [ListTriggersParams](/types/list-triggers-params) · [TriggerFilter](/types/trigger-filter) · [TriggerOrderBy](/types/trigger-order-by) · [TriggerShorthands](/types/trigger-shorthands) · [Page](/types/page) · [Trigger](/types/trigger)

### `usePurgeTrigger` `composite`

Permanently delete a soft-deleted trigger.

```ts
usePurgeTrigger(options?: MutationOpts<SuccessResponse, PurgeTriggerParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [PurgeTriggerParams](/types/purge-trigger-params)

### `useRestoreTrigger` `composite`

Restore a soft-deleted trigger.

```ts
useRestoreTrigger(options?: MutationOpts<Trigger, string>)
```

**Types:** [Trigger](/types/trigger)

### `useRetrieveTrigger` `query`

Get a trigger by ID.

```ts
useRetrieveTrigger(id: string, options?: QueryOpts<Trigger>)
```

**Types:** [Trigger](/types/trigger)

### `useUpdateTrigger` `mutation`

Update a trigger.

```ts
useUpdateTrigger(options?: MutationOpts<Trigger, UpdateTriggerParams>)
```

**Types:** [Trigger](/types/trigger) · [UpdateTriggerParams](/types/update-trigger-params)