---
title: "overlane inbox preferences"
description: "Show how you are told about each kind of event"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane inbox preferences

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

Prints, for each kind of event (ci_failed, deploy_failed, deploy_rolled_back, approval_requested, alert_fired, run_error, digest, import_finished), whether you are told in the app, by email or not at all. A kind you never chose is told in the app.

## Usage

```sh
overlane inbox preferences [--service URL]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--service` | string | no |  | The service address (default: OVERLANE_SERVICE_URL, then the project's binding, then the hosted service) |

## Examples

```sh
overlane inbox preferences
overlane inbox preferences --json
```

## Behavior

- Effect: `read` (changes nothing).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: no. Accepts `--force`: no.
- Machine-readable description: `overlane schema inbox preferences`.

## Result

With `--json` (the default when stdout is not a terminal) the command prints this JSON Schema's shape on stdout.

```json
{
  "type": "object",
  "properties": {
    "preferences": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "enum": [
          "ci_failed",
          "deploy_failed",
          "deploy_rolled_back",
          "approval_requested",
          "alert_fired",
          "run_error",
          "digest",
          "import_finished"
        ]
      },
      "additionalProperties": {
        "type": "string",
        "enum": [
          "in_app",
          "email",
          "none"
        ]
      },
      "required": [
        "ci_failed",
        "deploy_failed",
        "deploy_rolled_back",
        "approval_requested",
        "alert_fired",
        "run_error",
        "digest",
        "import_finished"
      ]
    }
  },
  "required": [
    "preferences"
  ],
  "additionalProperties": false
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/inbox-preferences/index.mdx