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

# Create a notification



## OpenAPI

````yaml /openapi.yaml post /notifications
openapi: 3.1.0
info:
  title: Pixwel Platform
  description: >-
    The Pixwel Platform REST API. Authenticate with HTTP Basic (email +
    password) or a personal access token (`Authorization: Bearer pat_…`).
    Responses are decorated by proxy middleware (Fields, Links, Permissions,
    etc.). Use `?fields=` to request specific fields.
  version: '2.8'
  contact:
    email: jeff@pixwel.com
  license:
    name: UNLICENSED
    identifier: LicenseRef-Pixwel-Proprietary
servers:
  - url: https://api-staging.pixwel.com/api
    description: Staging
  - url: https://app.pixwel.com/api
    description: Production
security:
  - BasicAuth: []
  - BearerAuth: []
paths:
  /notifications:
    post:
      tags:
        - Notifications
      summary: Create a notification
      operationId: createNotification
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationsResponse'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsResponse'
        '401':
          description: Not authenticated
components:
  schemas:
    NotificationsResponse:
      type: object
      properties:
        _id:
          type: string
          example: 507f1f77bcf86cd799439011
        from:
          type: string
          example: 507f1f77bcf86cd799439011
        to:
          type: string
          example: 507f1f77bcf86cd799439011
        event:
          type: object
          properties:
            _id:
              type: string
              example: 507f1f77bcf86cd799439011
            processed:
              type: boolean
            pushed:
              type: boolean
            digested:
              type: boolean
            created:
              type: integer
            body:
              type: string
            graphicsFile:
              type: object
              properties:
                id:
                  type: string
                url:
                  type: string
                  format: uri
                  example: https://example.com/path/to/object
                name:
                  type: string
                rootId:
                  type: string
                version:
                  type: integer
            graphicsComment:
              type: object
              properties:
                id:
                  type: string
                replyTo:
                  type: string
                body:
                  type: string
                user:
                  type: object
                  properties:
                    _id:
                      type: string
                      example: 507f1f77bcf86cd799439011
                    name:
                      type: string
                    email:
                      type: string
                      format: email
                      example: user@example.com
                created:
                  type: integer
                fileId:
                  type: string
            notify:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: string
                    example: 507f1f77bcf86cd799439011
                groups:
                  type: array
                  items:
                    type: string
                    example: 507f1f77bcf86cd799439011
            from:
              type: object
              properties:
                _id:
                  type: string
                  example: 507f1f77bcf86cd799439011
                status:
                  type: object
                  properties:
                    invited:
                      type: boolean
                    approved:
                      type: boolean
                    registered:
                      type: boolean
                    confirmed:
                      type: boolean
                invite:
                  type: string
                  format: uri
                  example: https://example.com/path/to/object
                name:
                  type: string
                username:
                  type: string
                  format: email
                  example: user@example.com
                emailNormal:
                  type: string
                  format: email
                  example: user@example.com
            type:
              type: string
            workRequest:
              type: object
              properties:
                _id:
                  type: string
                  example: 507f1f77bcf86cd799439011
                auto:
                  type: boolean
                autosubs:
                  type: boolean
                dualLanguages:
                  type: boolean
                aspectRatio:
                  type: string
                status:
                  type: string
                from:
                  type: string
                  example: 507f1f77bcf86cd799439011
                asset:
                  type: string
                  example: 507f1f77bcf86cd799439011
                assetType:
                  type: string
                assetCategory:
                  type: string
                due:
                  type: object
                  properties:
                    date:
                      type: integer
                    tz:
                      type: string
                deliveryDeadline:
                  type: object
                  properties:
                    date:
                      type: integer
                    tz:
                      type: string
                autoMode:
                  type: boolean
                language:
                  type: string
                territory:
                  type: string
                dng:
                  type: object
                  properties:
                    dialogue:
                      type: array
                      items:
                        type: string
                    graphics:
                      type: array
                      items:
                        type: string
                    narration:
                      type: array
                      items:
                        type: string
                audioFile:
                  description: Null in every sampled response — shape not inferred
                instructions:
                  type: string
                urls:
                  type: object
                  properties:
                    view:
                      type: string
                      format: uri
                      example: https://example.com/path/to/object
                    manage:
                      type: string
                      format: uri
                      example: https://example.com/path/to/object
                    invite:
                      type: string
                      format: uri
                      example: https://example.com/path/to/object
                    translate:
                      type: string
                      format: uri
                      example: https://example.com/path/to/object
                files:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                      files:
                        description: >-
                          Shape not inferred — the sampled response had no
                          entries
                uses:
                  type: object
                  properties:
                    items:
                      type: array
                      items:
                        type: string
                    details:
                      oneOf:
                        - type: object
                          additionalProperties:
                            type: array
                            items:
                              type: object
                              properties:
                                value:
                                  type: string
                                ship:
                                  type: boolean
                          description: >-
                            Keys are chosen at runtime and are not part of the
                            contract.
                        - type: array
                          maxItems: 0
                          description: An empty map, which PHP serializes as `[]`.
                dcp:
                  type: object
                  properties:
                    items:
                      type: array
                      items:
                        type: string
                    details:
                      oneOf:
                        - type: object
                          additionalProperties:
                            type: object
                            properties:
                              link:
                                type: boolean
                              ship:
                                type: boolean
                              quantity:
                                type: integer
                          description: >-
                            Keys are chosen at runtime and are not part of the
                            contract.
                        - type: array
                          maxItems: 0
                          description: An empty map, which PHP serializes as `[]`.
                recipients:
                  oneOf:
                    - type: object
                      additionalProperties:
                        description: >-
                          Shape not inferred — the sampled response had no
                          entries
                      description: >-
                        Keys are chosen at runtime and are not part of the
                        contract.
                    - type: array
                      maxItems: 0
                      description: An empty map, which PHP serializes as `[]`.
                shippingAddresses:
                  oneOf:
                    - type: object
                      description: >-
                        Keys are chosen at runtime and are not part of the
                        contract.
                    - type: array
                      maxItems: 0
                      description: An empty map, which PHP serializes as `[]`.
                project:
                  type: string
                  example: 507f1f77bcf86cd799439011
                studio:
                  type: string
                  example: 507f1f77bcf86cd799439011
                estimate:
                  type: object
                  properties:
                    base:
                      type:
                        - object
                        - 'null'
                      properties:
                        graphics:
                          type: integer
                        narration:
                          type: integer
                        scripts:
                          type: integer
                        dubbing:
                          type: integer
                        subtitling:
                          type: integer
                        hybrid:
                          type: integer
                        encoding:
                          type: integer
                        autosubs:
                          type: integer
                        autogfx:
                          type: integer
                    applied:
                      type:
                        - object
                        - 'null'
                      properties:
                        graphics:
                          type: integer
                        narration:
                          type: integer
                        scripts:
                          type: integer
                        dubbing:
                          type: integer
                        subtitling:
                          type: integer
                        hybrid:
                          type: integer
                        encoding:
                          type: integer
                        autosubs:
                          type: integer
                        autogfx:
                          type: integer
                        files:
                          type: integer
                        total:
                          type: integer
                materials:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                      complete:
                        type: boolean
                      approved:
                        type: boolean
                      files:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                url:
                                  type: string
                                  format: uri
                                  example: https://example.com/path/to/object
                                name:
                                  type: string
                                uploadedAt:
                                  type: integer
                                rootId:
                                  type: string
                                version:
                                  type: integer
                                isCurrentVersion:
                                  type: boolean
                                previousVersionId:
                                  description: >-
                                    Null in every sampled response — shape not
                                    inferred
                            - type: string
                              format: uri
                              example: https://example.com/path/to/object
                      changeRequests:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            _id:
                              type: string
                            _optimistic:
                              type: boolean
                            fileId:
                              type: string
                            body:
                              type: string
                            status:
                              type: string
                            user:
                              type: object
                              properties:
                                _id:
                                  type: string
                                  example: 507f1f77bcf86cd799439011
                                name:
                                  type: string
                                email:
                                  type: string
                                  format: email
                                  example: user@example.com
                            requestedBy:
                              type: object
                              properties:
                                _id:
                                  type: string
                                  example: 507f1f77bcf86cd799439011
                                email:
                                  type: string
                                  format: email
                                  example: user@example.com
                            requestedAt:
                              type: integer
                            created:
                              type: integer
                            replies:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  _id:
                                    type: string
                                  _optimistic:
                                    type: boolean
                                  replyTo:
                                    type: string
                                  body:
                                    type: string
                                  user:
                                    type: object
                                    properties:
                                      _id:
                                        type: string
                                        example: 507f1f77bcf86cd799439011
                                      name:
                                        type: string
                                      email:
                                        type: string
                                        format: email
                                        example: user@example.com
                                  created:
                                    type: integer
                                  editedAt:
                                    type: integer
                            editedAt:
                              type: integer
                rejections:
                  description: Shape not inferred — the sampled response had no entries
                history:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: integer
                      user:
                        type: object
                        properties:
                          _id:
                            type: string
                            example: 507f1f77bcf86cd799439011
                          emailNormal:
                            type: string
                            format: email
                            example: user@example.com
                          name:
                            type: string
                          groups:
                            type: array
                            items:
                              type: object
                              properties:
                                _id:
                                  type: string
                                  example: 507f1f77bcf86cd799439011
                                name:
                                  type: string
                      status:
                        type: string
                      reason:
                        type: string
                reason:
                  type: string
                graphicsTranslation:
                  type: string
                  example: 507f1f77bcf86cd799439011
                translation:
                  type: string
                  example: 507f1f77bcf86cd799439011
                tags:
                  description: Shape not inferred — the sampled response had no entries
            projects:
              type: array
              items:
                type: object
                properties:
                  _id:
                    type: string
                    example: 507f1f77bcf86cd799439011
                  name:
                    type: string
                  slug:
                    type: string
            assets:
              type: array
              items:
                type: object
                properties:
                  _id:
                    type: string
                    example: 507f1f77bcf86cd799439011
                  name:
                    type: string
                  project:
                    type: string
                    example: 507f1f77bcf86cd799439011
                  type:
                    type: string
                  notifyUrl:
                    type: string
                    format: uri
                    example: https://example.com/path/to/object
            urls:
              type: object
              properties:
                view:
                  type: string
                  format: uri
                  example: https://example.com/path/to/object
                manage:
                  type: string
                  format: uri
                  example: https://example.com/path/to/object
                invite:
                  type: string
                  format: uri
                  example: https://example.com/path/to/object
                translate:
                  type: string
                  format: uri
                  example: https://example.com/path/to/object
            assetTypes:
              type: array
              items:
                type: string
        type:
          type: string
        title:
          type: string
        emailSubject:
          type: string
        read:
          type: boolean
        viewed:
          type: boolean
        sent:
          type: boolean
        added:
          type: integer
        created:
          type: integer
        $links:
          type: object
          properties:
            self:
              type: string
              format: uri-reference
              example: //example.com/path/to/object
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Email address and password. A personal access token (`pat_…`) or session
        token (`token-…`) may also be sent in the password field, with any
        non-empty value as the username — a blank username short-circuits to a
        401 before the token is read.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: pat_<64 hex characters>
      description: >-
        A personal access token: `Authorization: Bearer pat_…`. Create one under
        Preferences → API Tokens, or with `POST /personal-access-tokens`. The
        token acts as its owner, with their full permissions.

````