Notifications (admin) API

Base URL: https://YOUR-SERVER/api. Send your API key in x-api-key where authentication is required. A key also needs the listed permission; your account's access rules still apply.

API guide · All endpoints · OpenAPI JSON

• POST /admin/notifications — Create a notification
• POST /admin/notifications/templates/{name} — Render email template
• POST /admin/notifications/test-email — Send test email

Create a notification

POST /api/admin/notifications

Create a new notification for a specific user.

Administrator access required.

Authentication: API key. Permission: all.

Request body

Required.

Field definitions: NotificationCreateDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/NotificationCreateDto"
    }
  }
}

Responses

Field definitions: NotificationDto

{
  "201": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/NotificationDto"
        }
      }
    },
    "description": ""
  }
}

Render email template

POST /api/admin/notifications/templates/{name}

Retrieve a preview of the provided email template.

Administrator access required.

Authentication: API key. Permission: all.

Parameters

Name	Where	Required	Description
name	path	Yes	string

Parameter types, defaults and constraints

[
  {
    "name": "name",
    "required": true,
    "in": "path",
    "schema": {
      "type": "string"
    }
  }
]

Request body

Required.

Field definitions: TemplateDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/TemplateDto"
    }
  }
}

Responses

Field definitions: TemplateResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/TemplateResponseDto"
        }
      }
    },
    "description": ""
  }
}

Send test email

POST /api/admin/notifications/test-email

Send a test email using the provided SMTP configuration.

Administrator access required.

Authentication: API key. Permission: all.

Request body

Required.

Field definitions: AdminConfigSmtpDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/AdminConfigSmtpDto"
    }
  }
}

Responses

Field definitions: TestEmailResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/TestEmailResponseDto"
        }
      }
    },
    "description": ""
  }
}