aYOUne
← CRM API

Notifications

Singular: Notification — Base-URL: https://crm-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

play_circle Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "_id": "6a8a6bccb9f464b80c1af4d9",
    "user": "6045f4d25704710012485569",
    "adminNotification": false,
    "userNotification": true,
    "markread": false,
    "icon": "info",
    "mess": "Tasks created by System",
    "title": "Schema-Drop: PostComments.create",
    "category": "Tasks",
    "sensitivity": "work",
    "obj": "6a8a6bccfe2f32a4c6f2b9c3",
    "view": "",
    "attachments": [
      {
        "type": "task",
        "preview": {
          "_id": "6a8a6bccfe2f32a4c6f2b9c3",
          "ticketIdentifier": "NWG5W0L",
          "title": "Schema-Drop: PostComments.create",
          "subject": "Schema-Drop: PostComments.create",
          "status": "open",
          "priority": "normal",
          "type": "Bug",
          "typeIcon": "check",
          "color": "#b70000",
          "assignee": {
            "_id": "5a76d07e2d8b3270ff6df587"
          },
          "points": 0,
          "tags": [],
          "escalated": false,
          "escalatedUser": "",
          "watchersCount": 0,
          "reactionsCount": 0,
          "commentsCount": 0,
          "createdAt": "2026-08-23T03:41:00.300Z",
          "updatedAt": "2026-08-23T03:41:00.409Z",
          "isError": true,
          "errorDetails": {
            "origin": "mongoose-strict-drop",
            "app": "ayoune-api-cms-develop-node-76d87d55b4-g2fh7[kube]@2026.45.0",
            "pod": "ayoune-api-cms-develop-node-76d87d55b4-g2fh7",
            "stack": "Error: schema-drop\n    at reportStrictDrops (/app/node_modules/@tolinax/ayoune-core/lib/database/strictDropDetection/reportStrictDrops.js:79:20)\n    at checkStrictDrops (/app/node_modules/@tolinax/ayoune-core/lib/database/strictDropDetection/index.js:44:47)\n    at /app/node_modules/@tolinax/ayoune-core/lib/database/methods/create/create.js:22:48\n    at Generator.next (<anonymous>)\n    at fulfilled (/app/node_modules/@tolinax/ayoune-core/lib/database/methods/create/create.js:5:58)\n    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)",
            "originData": "{\n    \"model\": \"PostComments\",\n    \"operation\": \"create\",\n    \"dropped\": [\n        \"name\"\n    ],\n    \"droppedCount\": 1,\n    \"debugId\": \"6a8a6bcc8a42a2c4f85a1980\",\n    \"_user\": \"6045f4d25704710012485569\"\n}",
            "service": {
              "name": "ayoune-api-cms",
              "env": "develop",
              "workload": "node"
            },
            "repoUrl": "https://bitbucket.org/ayoune/ayoune-api-cms",
            "pipelineUrl": "https://bitbucket.org/ayoune/ayoune-api-cms/pipelines",
            "deploymentUrl": "https://superuser.ayoune.app/home/k8-deployments?q=ayoune-api-cms-develop-node"
          }
        },
        "actions": [
          {
            "id": "open",
            "type": "link",
            "label": "Öffnen",
            "icon": "open_in_new",
            "href": "/pm/tasks/6a8a6bccfe2f32a4c6f2b9c3"
          },
          {
            "id": "complete",
            "type": "api",
            "label": "Erledigt",
            "icon": "check_circle",
            "endpoint": "https://pm-api.ayoune.app/tasks/6a8a6bccfe2f32a4c6f2b9c3/actions/complete",
            "method": "POST",
            "dismissOnComplete": true
          }
        ]
      }
    ],
    "actions": [
      {
        "id": "open-entity",
        "label": "Öffnen",
        "type": "link",
        "style": "secondary",
        "icon": "open_in_new",
        "href": "/go/pm/tasks/6a8a6bccfe2f32a4c6f2b9c3"
      }
    ],
    "image": "https://cm.ayoune.app/tolinax-demo/hero.jpg",
    "tag": "Tasks:6a8a6bccfe2f32a4c6f2b9c3",
    "isDraft": true,
    "createdAt": "2026-08-23T03:41:00.524Z",
    "updatedAt": "2026-08-23T03:41:00.524Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://crm-api.ayoune.app/notifications/6a8a6bccb9f464b80c1af4d9",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a8d0e97472aac3767baeeff",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_NOTIFICATION",
        "href": "https://api.ayoune.app/crm/notifications/6a8a6bccb9f464b80c1af4d9/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_NOTIFICATION",
        "href": "https://api.ayoune.app/crm/notifications/6a8a6bccb9f464b80c1af4d9",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.77.0",
      "core": "2026.319.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2267",
      "reset": "1787632736",
      "resetDate": "Tue Aug 25 2026"
    },
    "responseTime": 18.38663,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /notifications Liste mit Filtern/Paginierung crm.notifications.view
GET /notifications/:id Einzelner Datensatz crm.notifications.view
POST /notifications Neuen Datensatz erstellen crm.notifications.new
PUT /notifications Datensatz aktualisieren crm.notifications.edit
DELETE /notifications/:id Datensatz löschen crm.notifications.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// Alle abrufen
const list = await ay.crm.notifications.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.crm.notifications.findById('OBJECT_ID').exec();

// Erstellen
const created = await ay.crm.notifications.create({ name: 'Foo' });

Weiterführend