# Segments

> Saved filters over a subject type, such as companies in a region or deals over a size: the matching records materialized as members, refreshed on demand or from a cron, with an event when a record enters or leaves.

- Category: CRM & sales
- Module: `segments`
- Modes: `managed`
- Docs: https://bettersupabase.com/docs/blocks/segments
- Page: https://bettersupabase.com/blocks/segments

## Install

```bash
npx better-supabase add segments
```

The command also installs `updated-at`, `tenant`, `access`, `subjects`, `rules`.

## Configure

Add the block to `better-supabase.config.ts`:

```ts
import { defineConfig } from "better-supabase/config";

export default defineConfig({
  blocks: {
    // Required by segments; add installs them too.
    "updated-at": {},
    tenant: {},
    access: {},
    subjects: {},
    rules: {},
    // Modes: "managed". The default is "managed".
    segments: { mode: "managed" },
  },
});
```

## Client

The block has no React entry yet. Its server-side TypeScript is in `better-supabase/blocks/segments`.

## Events

- `segment.entered`
- `segment.left`
- `segment.removed`
- `segment.saved`

## Related blocks

Requires: [tenant](https://bettersupabase.com/blocks/tenant.md), [access](https://bettersupabase.com/blocks/access.md), [subjects](https://bettersupabase.com/blocks/subjects.md), [rules](https://bettersupabase.com/blocks/rules.md)

Works with: [outbox](https://bettersupabase.com/blocks/outbox.md), [audit](https://bettersupabase.com/blocks/audit.md), [data-lifecycle](https://bettersupabase.com/blocks/data-lifecycle.md)