---
title: "custom"
description: "Fields of a `custom` variable."
---

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

# custom

## Example

```json
{
  "name": "env",
  "type": "custom",
  "options": [
    "prod",
    "staging"
  ]
}
```

From [`spec/examples/decision9-features.json`](https://github.com/slashobserve/slashobserve/blob/main/spec/examples/decision9-features.json).

## Fields

| Field | Type | Description |
| --- | --- | --- |
| `name` (required) | `variableName` | Referenced in queries as $name, ${name} or ${name:format}. |
| `label` | `string` |   |
| `description` | `string` |   |
| `hide` | `"label"`, `"variable"` |   |
| `skipUrlSync` | `boolean` | The variable's value is not read from or written to the URL. |
| `type` (required) | `"custom"` |   |
| `options` (required) | array of `string` or `object` | At most 200 items. |
| `allowCustomValue` | `boolean` |   |
| `multi` | `boolean` |   |
| `includeAll` | `boolean` |   |
| `allValue` | `string` |   |
| `default` | `selection` | Default selection: one value, several for a multi variable, or $__all. |

Generated from [`spec/schema/observespec.v0.json`](https://github.com/slashobserve/slashobserve/blob/bac0fe39/spec/schema/observespec.v0.json) at `bac0fe39`. [Report a problem](https://github.com/slashobserve/slashobserve/issues/new).