# NotificationDefaults

The organisation's default browser push notifications: which events are pushed to a person who has not chosen for themselves.

The organisation's default browser push notifications: which events are pushed to a person who has not chosen for themselves. A person's own choices on the notifications page still win. One per tenant, named default. The document replaces the defaults whole, as the console's tenant defaults form does. Deleting it removes the organisation's defaults, so the catalogue defaults apply again.

| | |
|---|---|
| `apiVersion` | `vulnetix.com/v1` |
| `kind` | `NotificationDefaults` |
| Group | [Org](/platform-iac/kinds/catalogue.md#org) |
| Status | **Served.** The [config engine](/platform-iac/reference/engine.md) plans and applies it. |
| Objects per tenant | one (`metadata.name: default`) |
| Token and role | An owner, or a service account with the developer role (its ApiKey), or an Authentik access token for either. A member is refused with HTTP 403. See [Credentials for automation](/platform-iac/reference/config-api.md#credentials-for-automation). |
| Terraform resource | [`vulnetix_notification_defaults`](/platform-iac/terraform/resources.md#vulnetix_notification_defaults), imported by name (see [Terraform and OpenTofu](#terraform-and-opentofu)) |
| CLI | [`vulnetix config apply`](/platform-iac/cli/apply.md), CLI v3.168.0 and later. |
| Pinned schema | [`v1.19.1/NotificationDefaults.schema.json`](https://github.com/Vulnesis/config-schemas/releases/download/v1.19.1/NotificationDefaults.schema.json) |
| Newest schema | [`latest/NotificationDefaults.schema.json`](https://github.com/Vulnesis/config-schemas/releases/latest/download/NotificationDefaults.schema.json) |
| First released in | [`v1.5.0`](https://github.com/Vulnesis/config-schemas/releases/tag/v1.5.0) |
| Print the built-in copy | `vulnetix config schema NotificationDefaults` |

## Minimal

Only the fields the kind requires. From `examples/NotificationDefaults/minimal.yaml`.

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/NotificationDefaults.schema.json
apiVersion: vulnetix.com/v1
kind: NotificationDefaults
metadata:
  name: default
spec:
  push: {}
```

**HCL** (resource `vulnetix_notification_defaults`)

```hcl
# Only the arguments the kind requires. From config-schemas examples/NotificationDefaults/minimal.yaml.

resource "vulnetix_notification_defaults" "default" {
  push = {
  }
}
```

Every field that has a schema default, set to that default: [`terraform/notification_defaults.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/notification_defaults.tf) and [`yaml/NotificationDefaults.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/NotificationDefaults.yaml) in [Vulnesis/platform-iac-examples](https://github.com/Vulnesis/platform-iac-examples).

**CLI** (applies it)

```bash
export VULNESIS_ORG_ID=...    # the organization UUID
export VULNESIS_API_KEY=...   # the ApiKey of a developer or owner service account
vulnetix config apply -f - --manager gitops:acme/platform --auto-approve <<'EOF'
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/NotificationDefaults.schema.json
apiVersion: vulnetix.com/v1
kind: NotificationDefaults
metadata:
  name: default
spec:
  push: {}
EOF
```

## Advanced

Every field the kind supports, with a `when` expression where it takes one. From `examples/NotificationDefaults/advanced.yaml`.

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/NotificationDefaults.schema.json
apiVersion: vulnetix.com/v1
kind: NotificationDefaults
metadata:
  name: default
  annotations:
    ticket: https://tracker.example.com/OPS-77
spec:
  push:
    "*": false
    tier:needs_you: true
    tier:error: true
    factory.run.*: true
    factory.run.succeeded: false
```

**HCL** (resource `vulnetix_notification_defaults`)

```hcl
# Every argument the kind supports. From config-schemas examples/NotificationDefaults/advanced.yaml.

resource "vulnetix_notification_defaults" "default" {
  push = {
    "*"                     = false
    "factory.run.*"         = true
    "factory.run.succeeded" = false
    "tier:error"            = true
    "tier:needs_you"        = true
  }
  annotations = {
    ticket = "https://tracker.example.com/OPS-77"
  }
}
```

Every field that has a schema default, set to that default: [`terraform/notification_defaults.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/notification_defaults.tf) and [`yaml/NotificationDefaults.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/NotificationDefaults.yaml) in [Vulnesis/platform-iac-examples](https://github.com/Vulnesis/platform-iac-examples).

**CLI** (applies it)

```bash
export VULNESIS_ORG_ID=...    # the organization UUID
export VULNESIS_API_KEY=...   # the ApiKey of a developer or owner service account
vulnetix config apply -f - --manager gitops:acme/platform --auto-approve <<'EOF'
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/NotificationDefaults.schema.json
apiVersion: vulnetix.com/v1
kind: NotificationDefaults
metadata:
  name: default
  annotations:
    ticket: https://tracker.example.com/OPS-77
spec:
  push:
    "*": false
    tier:needs_you: true
    tier:error: true
    factory.run.*: true
    factory.run.succeeded: false
EOF
```

## Fields

Paths use dots for nesting and `[]` for the items of a list. **Required** means required whenever the parent object is present. A default is what the server uses when the field is left out.

| Field | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| <span id="apiVersion"></span>`apiVersion` | string | yes |  | exactly `vulnetix.com/v1` | The document format version. Every kind in this release is vulnetix.com/v1. |
| <span id="kind"></span>`kind` | string | yes |  | exactly `NotificationDefaults` | Always NotificationDefaults. |
| <span id="metadata"></span>`metadata` | object | yes |  | no other keys | Metadata for a kind the tenant has exactly one of. The name is fixed to default. |
| <span id="metadata-name"></span>`metadata.name` | string | yes |  | exactly `default`; pattern `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$` | The object's name, unique per kind within a tenant. It is the natural key: plan, apply, export and the Terraform provider all address an object by kind and name. |
| <span id="metadata-org"></span>`metadata.org` | string | no |  | format `uuid` | The tenant (organization UUID) the document belongs to. When set, plan and apply refuse to run against any other tenant. |
| <span id="metadata-labels"></span>`metadata.labels` | object | no |  | map of string to string (length 0 to 256); keys match `^[a-z0-9]([a-z0-9._/-]{0,61}[a-z0-9])?$` | Free key/value labels. Stored with the object, never interpreted by the server. |
| <span id="metadata-annotations"></span>`metadata.annotations` | object | no |  | map of string to string (length 0 to 4096) | Free key/value notes for people and tools, such as a ticket link. |
| <span id="spec"></span>`spec` | object | yes |  | no other keys |  |
| <span id="spec-push"></span>`spec.push` | object | yes |  | 0 to 500 keys; map of string to boolean; keys match `^(\*\|tier:(needs_you\|error\|warning\|info)\|[a-z0-9_]+(\.[a-z0-9_]+)*(\.\*)?)$` | Whether each event is pushed, keyed by an event type (factory.run.failed), a family (factory.run.*, or * for every event) or a tier (tier:needs_you, tier:error, tier:warning, tier:info). The most specific key wins: a type over its families, and a family over *. An empty object sets no defaults of the organisation's own. |

## Applying this kind

- **Command.** `vulnetix config apply -f <file>`; the CLI line above says from which release. Plan first with [`vulnetix config plan`](/platform-iac/cli/plan.md): it shows each object as create, update, delete or no change, with a `planHash` that apply then holds to. Apply writes in one transaction.
- **Manager.** Each object records the manager that applied it (`terraform`, `console` or `gitops:<repo>`). `--prune` deletes only objects its own manager owns. See [The manager](/platform-iac/cli/plan.md#the-manager) and the [config engine](/platform-iac/reference/engine.md).
- **Status.** Applied, Unchanged or Deleted, with no other status fields. The phases the engine reports are explained under [status phases](/platform-iac/reference/engine.md#status-phases).
- **Singleton.** There is one per tenant, and its name is always `default`.

## How apply treats it

- A singleton that replaces: written through the same function as the tenant defaults form, so each change is a factory setting event and an audit entry. Validated like the form.
- Delete removes the setting, so the catalogue defaults apply.
- It does not include the `notify.events` preset, which is a [`FactorySettings`](/platform-iac/kinds/factory-settings.md) field. `FactorySettings` must not also manage `notify.push.defaults`, or the two kinds would fight over it.

## Terraform and OpenTofu

The resource is `vulnetix_notification_defaults` in the `vulnetix/resolve` provider. Its arguments are the `spec` in snake case, beside `name`, `labels` and `annotations` from `metadata`. The Minimal and Advanced HCL are above. The provider's own reference is [vulnetix_notification_defaults](https://registry.terraform.io/providers/vulnetix/resolve/latest/docs/resources/notification_defaults).

Import an object that already exists by its name (`default`):

```shell
# Import an existing NotificationDefaults by its name (metadata.name).
terraform import vulnetix_notification_defaults.default default
```

Install, authentication and how state is read: [Terraform and OpenTofu](/platform-iac/terraform.md).

Check a file with `vulnetix config validate -f <file>`. See [Validate documents](/platform-iac/cli/validate.md). In an editor, start the file with the [schema comment](/platform-iac/schemas/editors.md).
