PipesHub · Schema

InAppNotification

A user notification record persisted by `NotificationConsumer` in MongoDB (`notification.schema.ts`). The document is scoped to a single user via `assignedTo` and expires automatically after 30 days (TTL index).

CompanyArtificial IntelligenceEnterprise SearchAI AgentsOpen SourceKnowledge ManagementWorkplace AI

Properties

Name Type Description
_id string MongoDB ObjectId of the notification document
orgId string Organisation the notification belongs to
type string Notification type discriminator. Connector-originated values include `CONNECTOR_AUTH_ERROR`, `CONNECTOR_SYNC_ERROR`, `CONNECTOR_WARNING`, `CONNECTOR_INFO`, `CONNECTOR_SUCCESS`, etc.
title string Short human-readable heading
message string Full notification body text
severity string Visual severity level
status string Read/unread state of the notification for this user
originService string Service that generated the notification
assignedTo string MongoDB ObjectId of the user this notification is assigned to
redirectLink string Optional deep-link URL the user should be sent to when clicking the notification
payload object Arbitrary structured data attached by the originating service. Connector notifications typically include `connectorId`, `connectorName`, and `errorCode` keys.
isDeleted boolean Soft-delete flag; deleted notifications are excluded from all list queries
deletedBy string ObjectId of the user who dismissed the notification (set on soft-delete)
createdAt string ISO 8601 timestamp — documents are TTL-expired 30 days after this value
updatedAt string
View JSON Schema on GitHub

JSON Schema

pipeshub-in-app-notification-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pipeshub/json-schema/pipeshub-in-app-notification-schema.json",
  "title": "InAppNotification",
  "description": "A user notification record persisted by `NotificationConsumer` in MongoDB\n(`notification.schema.ts`). The document is scoped to a single user via\n`assignedTo` and expires automatically after 30 days (TTL index).\n",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pipeshub-notifications-api-openapi.yml#/components/schemas/InAppNotification",
  "type": "object",
  "required": [
    "_id",
    "orgId",
    "type",
    "status",
    "assignedTo",
    "isDeleted",
    "createdAt",
    "updatedAt"
  ],
  "properties": {
    "_id": {
      "type": "string",
      "format": "objectId",
      "description": "MongoDB ObjectId of the notification document"
    },
    "orgId": {
      "type": "string",
      "format": "objectId",
      "description": "Organisation the notification belongs to"
    },
    "type": {
      "type": "string",
      "description": "Notification type discriminator. Connector-originated values include\n`CONNECTOR_AUTH_ERROR`, `CONNECTOR_SYNC_ERROR`, `CONNECTOR_WARNING`,\n`CONNECTOR_INFO`, `CONNECTOR_SUCCESS`, etc.\n"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable heading"
    },
    "message": {
      "type": "string",
      "description": "Full notification body text"
    },
    "severity": {
      "type": "string",
      "enum": [
        "info",
        "warning",
        "error",
        "critical",
        "success"
      ],
      "description": "Visual severity level"
    },
    "status": {
      "type": "string",
      "enum": [
        "read",
        "unread",
        "archived"
      ],
      "default": "unread",
      "description": "Read/unread state of the notification for this user"
    },
    "originService": {
      "type": "string",
      "enum": [
        "Connector Service",
        "Indexing Service",
        "AI Service",
        "External Service"
      ],
      "description": "Service that generated the notification"
    },
    "assignedTo": {
      "type": "string",
      "format": "objectId",
      "description": "MongoDB ObjectId of the user this notification is assigned to"
    },
    "redirectLink": {
      "type": "string",
      "description": "Optional deep-link URL the user should be sent to when clicking the notification"
    },
    "payload": {
      "type": "object",
      "additionalProperties": true,
      "description": "Arbitrary structured data attached by the originating service.\nConnector notifications typically include `connectorId`, `connectorName`,\nand `errorCode` keys.\n"
    },
    "isDeleted": {
      "type": "boolean",
      "default": false,
      "description": "Soft-delete flag; deleted notifications are excluded from all list queries"
    },
    "deletedBy": {
      "type": "string",
      "format": "objectId",
      "description": "ObjectId of the user who dismissed the notification (set on soft-delete)"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp — documents are TTL-expired 30 days after this value"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/pipeshub-in-app-notification"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.