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

# ConfigNotification

> Sample shape for ConfigNotification.

Sample shape for `ConfigNotification`.

## Sample JSON

Copy, edit, paste. Server-set fields (`id`, `created`, `tenantId`, …) are omitted from the example — they're populated by the server on response.

```json theme={null}
{
  "name": "Example name",
  "description": "Example description.",
  "active": false,
  "container": [
    "example"
  ],
  "interval": 0,
  "limiter": 0,
  "conditionGroup": [
    "<config-condition-group>"
  ],
  "recipientUserGroup": [
    "example"
  ],
  "recipientEmail": [
    "user@example.com"
  ],
  "recipientEndpoint": "example",
  "recipientSlackId": "<recipient-slack_id>",
  "recipientMsTeamsId": "<recipient-ms-teams_id>"
}
```

## Fields

| Field                | Type                                                                 | Required   | Notes                                   |
| -------------------- | -------------------------------------------------------------------- | ---------- | --------------------------------------- |
| `entity`             | string • nullable                                                    | Server-set | Set by the server. Read-only on writes. |
| `name`               | string                                                               | Optional   |                                         |
| `description`        | string                                                               | Optional   |                                         |
| `active`             | boolean                                                              | Optional   |                                         |
| `container`          | array\<string>                                                       | Optional   |                                         |
| `interval`           | integer                                                              | Optional   |                                         |
| `limiter`            | integer                                                              | Optional   |                                         |
| `conditionGroup`     | array\<[`ConfigConditionGroup`](/data-model/config-condition-group)> | Optional   |                                         |
| `recipientUserGroup` | array\<string>                                                       | Optional   |                                         |
| `recipientEmail`     | array\<string>                                                       | Optional   |                                         |
| `recipientEndpoint`  | string                                                               | Optional   |                                         |
| `recipientSlackId`   | string                                                               | Optional   |                                         |
| `recipientMsTeamsId` | string                                                               | Optional   |                                         |
| `tenantId`           | string                                                               | Server-set | Set by the server. Read-only on writes. |
| `id`                 | string                                                               | Server-set | Set by the server. Read-only on writes. |
| `created`            | string (date-time)                                                   | Server-set | Set by the server. Read-only on writes. |
| `createdBy`          | string                                                               | Server-set | Set by the server. Read-only on writes. |
| `updated`            | string (date-time)                                                   | Server-set | Set by the server. Read-only on writes. |
| `updatedBy`          | string                                                               | Server-set | Set by the server. Read-only on writes. |
| `deleted`            | boolean                                                              | Server-set | Set by the server. Read-only on writes. |

## Used by

### Request body

* `POST /api/notification`
* `PUT /api/notification`

### Response body

* `GET /api/notification/{id}`
* `GET /api/notification`

### CLI

`ekso notification` — see the [command branches](/cli/branches) page for available verbs. Body for create / update verbs typically passed via `--data @file.json` matching the [sample JSON](#sample-json) above.