# Triggers

> SDK methods for the Triggers module, accessed via `soat.triggers`. See the [Triggers module docs](/docs/modules/triggers) for permissions and data model, and each method's REST page for the full request/response schema.

# Triggers

SDK methods for the Triggers module, accessed via `soat.triggers`. See the [Triggers module docs](/docs/modules/triggers) for permissions and data model, and each method's REST page for the full request/response schema.

### `soat.triggers.listTriggers()`

List triggers

- Method: `GET`
- Path: `/api/v1/triggers`

```ts
await soat.triggers.listTriggers({
  query: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/triggers/list-triggers)

### `soat.triggers.createTrigger()`

Create a trigger

- Method: `POST`
- Path: `/api/v1/triggers`

```ts
await soat.triggers.createTrigger({
  body: { name, type, target_type, target_id, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/triggers/create-trigger)

### `soat.triggers.getTrigger()`

Get a trigger

- Method: `GET`
- Path: `/api/v1/triggers/{trigger_id}`

```ts
await soat.triggers.getTrigger({
  path: { trigger_id },
});
```

→ [Request & response schema](/docs/api/triggers/get-trigger)

### `soat.triggers.updateTrigger()`

Update a trigger

- Method: `PATCH`
- Path: `/api/v1/triggers/{trigger_id}`

```ts
await soat.triggers.updateTrigger({
  path: { trigger_id },
  body: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/triggers/update-trigger)

### `soat.triggers.deleteTrigger()`

Delete a trigger

- Method: `DELETE`
- Path: `/api/v1/triggers/{trigger_id}`

```ts
await soat.triggers.deleteTrigger({
  path: { trigger_id },
});
```

→ [Request & response schema](/docs/api/triggers/delete-trigger)

### `soat.triggers.fireTrigger()`

Fire a trigger

- Method: `POST`
- Path: `/api/v1/triggers/{trigger_id}/fire`

```ts
await soat.triggers.fireTrigger({
  path: { trigger_id },
  body: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/triggers/fire-trigger)

### `soat.triggers.getTriggerSecret()`

Get trigger secret

- Method: `GET`
- Path: `/api/v1/triggers/{trigger_id}/secret`

```ts
await soat.triggers.getTriggerSecret({
  path: { trigger_id },
});
```

→ [Request & response schema](/docs/api/triggers/get-trigger-secret)

### `soat.triggers.rotateTriggerSecret()`

Rotate trigger secret

- Method: `POST`
- Path: `/api/v1/triggers/{trigger_id}/rotate-secret`

```ts
await soat.triggers.rotateTriggerSecret({
  path: { trigger_id },
});
```

→ [Request & response schema](/docs/api/triggers/rotate-trigger-secret)

### `soat.triggers.listTriggerFirings()`

List trigger firings

- Method: `GET`
- Path: `/api/v1/trigger-firings`

```ts
await soat.triggers.listTriggerFirings({
  query: { trigger_id, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/triggers/list-trigger-firings)

### `soat.triggers.getTriggerFiring()`

Get a trigger firing

- Method: `GET`
- Path: `/api/v1/trigger-firings/{firing_id}`

```ts
await soat.triggers.getTriggerFiring({
  path: { firing_id },
});
```

→ [Request & response schema](/docs/api/triggers/get-trigger-firing)