Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

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. 
{
  "name": "Example name",
  "description": "Example description.",
  "active": false,
  "container": [
    "example"
  ],
  "interval": 0,
  "limiter": 0,
  "conditionGroup": [
    "<config-condition-group>"
  ],
  "recipientUserGroup": [
    "example"
  ],
  "recipientEmail": [
    "[email protected]"
  ],
  "recipientEndpoint": "example",
  "recipientSlackId": "<recipient-slack_id>",
  "recipientMsTeamsId": "<recipient-ms-teams_id>"
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
namestringOptional
descriptionstringOptional
activebooleanOptional
containerarray<string>Optional
intervalintegerOptional
limiterintegerOptional
conditionGrouparray<ConfigConditionGroup>Optional
recipientUserGrouparray<string>Optional
recipientEmailarray<string>Optional
recipientEndpointstringOptional
recipientSlackIdstringOptional
recipientMsTeamsIdstringOptional
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet 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 page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.