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

# Create a notification

> Create a new notification for a specific user or group of users



## OpenAPI

````yaml /api-reference/openapi.json post /api/notifications
openapi: 3.0.0
info:
  title: Open Attack Surface Management
  description: Open-source platform for cybersecurity Attack Surface Management (ASM)
  version: '1.0'
  contact: {}
servers:
  - url: https://{baseUrl}/api/v1
    variables:
      baseUrl:
        default: localhost:3000
        description: API server hostname with port (e.g. localhost:3000, api.example.com)
security: []
tags: []
externalDocs:
  description: Authentication Docs
  url: auth/docs
paths:
  /api/notifications:
    post:
      tags:
        - Notifications
      summary: Create a notification
      description: Create a new notification for a specific user or group of users
      operationId: NotificationsController_createNotification
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNotificationDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/AppResponseSerialization'
components:
  schemas:
    CreateNotificationDto:
      type: object
      properties:
        recipients:
          description: List of user IDs to receive the notification
          type: array
          items:
            type: string
        scope:
          type: string
          description: Type of the notification
          enum:
            - SYSTEM
            - USER
            - GROUP
          example: USER
        type:
          type: string
          description: Type of the notification
          enum:
            - WORKSPACE_CREATED
            - VULNERABILITY_ANALYSIS_COMPLETED
            - ASSET_NEW_DETECT
            - NEW_VULNERABILITY_FOUND
        metadata:
          type: object
          description: Metadata for the notification content (variables for translation)
          example:
            name: John Doe
      required:
        - recipients
        - scope
        - type
    AppResponseSerialization:
      type: object
      properties: {}

````