@epilot/sdk 2.0.0-beta.2 → 2.0.0-beta.4

package/definitions/notification.json

@@ -0,0 +1,1425 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Notification API",
+    "version": "1.7.0",
+    "description": "Notification API for epilot 360"
+  },
+  "security": [
+    {
+      "EpilotAuth": []
+    },
+    {
+      "EpilotOrg": []
+    }
+  ],
+  "tags": [
+    {
+      "name": "Notification",
+      "description": "Notification"
+    },
+    {
+      "name": "Template",
+      "description": "Notification Template"
+    }
+  ],
+  "paths": {
+    "/v2/notification/notifications": {
+      "get": {
+        "operationId": "getNotificationsV2",
+        "summary": "getNotificationsV2",
+        "description": "Get notifications items. These items may eventually contain entities within their payload, which can be hydrated by the client if desired by calling the Entity API directly.",
+        "tags": [
+          "Notification"
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "cursor",
+            "schema": {
+              "type": "string"
+            },
+            "required": false,
+            "description": "Base64 encoded cursor to be used for pagination"
+          },
+          {
+            "in": "query",
+            "name": "after_id",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "in": "query",
+            "name": "limit",
+            "schema": {
+              "type": "integer"
+            },
+            "description": "The numbers of items to return"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "cursor": {
+                      "type": "string",
+                      "example": "eyJjcmVhd",
+                      "description": "Base64 encoded cursor to be used for pagination"
+                    },
+                    "total": {
+                      "type": "integer",
+                      "example": 1
+                    },
+                    "total_unread": {
+                      "type": "integer",
+                      "example": 1
+                    },
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/NotificationItem"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/notification/notifications": {
+      "post": {
+        "operationId": "createNotification",
+        "summary": "createNotification",
+        "description": "Create a message that can be displayed in the notification panel.",
+        "tags": [
+          "Notification"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Notification"
+              }
+            }
+          }
+        },
+        "responses": {
+          "202": {
+            "description": "Success"
+          }
+        }
+      },
+      "get": {
+        "operationId": "getNotifications",
+        "summary": "getNotifications",
+        "description": "Get notifications",
+        "tags": [
+          "Notification"
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "after_id",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "in": "query",
+            "name": "limit",
+            "schema": {
+              "type": "integer"
+            },
+            "description": "The numbers of items to return"
+          },
+          {
+            "in": "query",
+            "name": "no_hydrate",
+            "schema": {
+              "type": "boolean"
+            },
+            "description": "When true, the payload will not be hydrated with the entity data. This is useful when the client does not need the entity data and wants to save on API calls (performance gain). When false, the payload will be hydrated with the entity data. This is useful when the client needs the entity data to display the notification (e.g. to show the name of the contact in the notification message), but can have a significative performance impact.\n\nThis endpoint will eventually be deprecated in favor of GET /v2/notification/notifications which no longer hydrates the payload by default.\n"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "total": {
+                      "type": "integer",
+                      "example": 1
+                    },
+                    "total_unread": {
+                      "type": "integer",
+                      "example": 1
+                    },
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/NotificationItem"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/notification/notifications/{id}": {
+      "get": {
+        "operationId": "getNotification",
+        "summary": "getNotification",
+        "description": "Get the details of a single notification.",
+        "tags": [
+          "Notification"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "description": "Notification Id",
+            "required": true,
+            "schema": {
+              "type": "number"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NotificationItem"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/notification/notifications/mark": {
+      "put": {
+        "operationId": "markAllAsRead",
+        "summary": "markAllAsRead",
+        "description": "Mark all as read",
+        "tags": [
+          "Notification"
+        ],
+        "responses": {
+          "204": {
+            "description": "ok"
+          }
+        }
+      }
+    },
+    "/v1/notification/notifications/{id}/mark": {
+      "put": {
+        "operationId": "markAsRead",
+        "summary": "markAsRead",
+        "description": "Mark as read",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "schema": {
+              "type": "integer"
+            },
+            "required": true,
+            "description": "Numeric ID of the notification to mark as read"
+          }
+        ],
+        "tags": [
+          "Notification"
+        ],
+        "responses": {
+          "204": {
+            "description": "Success"
+          }
+        }
+      }
+    },
+    "/v1/notification/unreads": {
+      "get": {
+        "operationId": "getTotalUnread",
+        "summary": "getTotalUnread",
+        "description": "Get total unread",
+        "tags": [
+          "Notification"
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "number",
+                  "example": 999
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/notification/templates": {
+      "get": {
+        "operationId": "listNotificationTemplates",
+        "summary": "listNotificationTemplates",
+        "description": "List notification templates with optional filtering and pagination",
+        "tags": [
+          "Template"
+        ],
+        "parameters": [
+          {
+            "name": "q",
+            "in": "query",
+            "required": false,
+            "description": "Lucene query string for filtering",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "from",
+            "in": "query",
+            "required": false,
+            "description": "Pagination offset (0-based)",
+            "schema": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 0
+            }
+          },
+          {
+            "name": "size",
+            "in": "query",
+            "required": false,
+            "description": "Results per page",
+            "schema": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 1000,
+              "default": 25
+            }
+          },
+          {
+            "name": "sort",
+            "in": "query",
+            "required": false,
+            "description": "Sort fields (prefix with - for descending)",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "fields",
+            "in": "query",
+            "required": false,
+            "description": "Comma-separated fields to include",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "hydrate",
+            "in": "query",
+            "required": false,
+            "description": "Resolve nested relations",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NotificationTemplateListResponse"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "operationId": "createNotificationTemplate",
+        "summary": "createNotificationTemplate",
+        "description": "Create a new notification template",
+        "tags": [
+          "Template"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateNotificationTemplateInput"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NotificationTemplate"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/notification/templates/{id}": {
+      "get": {
+        "operationId": "getNotificationTemplate",
+        "summary": "getNotificationTemplate",
+        "description": "Get a single notification template by ID",
+        "tags": [
+          "Template"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TemplateIdPathParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NotificationTemplate"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "put": {
+        "operationId": "updateNotificationTemplate",
+        "summary": "updateNotificationTemplate",
+        "description": "Update a notification template (full replacement)",
+        "tags": [
+          "Template"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TemplateIdPathParam"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateNotificationTemplateInput"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NotificationTemplate"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "patch": {
+        "operationId": "patchNotificationTemplate",
+        "summary": "patchNotificationTemplate",
+        "description": "Partially update a notification template",
+        "tags": [
+          "Template"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TemplateIdPathParam"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateNotificationTemplateInput"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NotificationTemplate"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteNotificationTemplate",
+        "summary": "deleteNotificationTemplate",
+        "description": "Delete a notification template permanently",
+        "tags": [
+          "Template"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TemplateIdPathParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NotificationTemplate"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/notification/templates/send-preview": {
+      "post": {
+        "operationId": "sendPreview",
+        "summary": "sendPreview",
+        "description": "Send a preview notification (both email and in-app) to the requesting user.\nUsed to test notification templates before saving.\n",
+        "tags": [
+          "Template"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SendPreviewInput"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Preview notification sent successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SendPreviewResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "EpilotAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "description": "Authorization header with epilot OAuth2 bearer token",
+        "bearerFormat": "JWT"
+      },
+      "EpilotOrg": {
+        "description": "Overrides the target organization to allow shared tenant access",
+        "name": "x-epilot-org-id",
+        "in": "header",
+        "type": "apiKey"
+      }
+    },
+    "parameters": {
+      "TemplateIdPathParam": {
+        "name": "id",
+        "in": "path",
+        "required": true,
+        "description": "Template ID (UUID)",
+        "schema": {
+          "type": "string",
+          "format": "uuid"
+        }
+      }
+    },
+    "schemas": {
+      "Error": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Error message"
+          },
+          "code": {
+            "type": "string",
+            "description": "Error code"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      },
+      "EntityOperation": {
+        "type": "object",
+        "properties": {
+          "entity": {
+            "$ref": "#/components/schemas/EntityId"
+          },
+          "operation": {
+            "type": "string",
+            "example": "updateEntity"
+          },
+          "params": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "#/components/schemas/EntityId"
+              },
+              "slug": {
+                "$ref": "#/components/schemas/EntitySlug"
+              }
+            },
+            "example": {
+              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+              "slug": "contact"
+            }
+          },
+          "payload": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/Entity"
+              },
+              {
+                "example": {
+                  "_schema": "contact",
+                  "_org": "123",
+                  "status": "Inactive"
+                }
+              }
+            ]
+          }
+        },
+        "required": [
+          "entity",
+          "name"
+        ]
+      },
+      "NotificationItem": {
+        "allOf": [
+          {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "#/components/schemas/Id"
+              },
+              "notification_id": {
+                "$ref": "#/components/schemas/NotificationId"
+              },
+              "timestamp": {
+                "type": "string",
+                "format": "date-time"
+              },
+              "read_state": {
+                "type": "boolean",
+                "example": false
+              }
+            }
+          },
+          {
+            "$ref": "#/components/schemas/NotificationBase"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "caller": {
+                "$ref": "#/components/schemas/NotificationCallerContext"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "properties": {
+              "operations": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/EntityOperation"
+                }
+              }
+            }
+          }
+        ]
+      },
+      "Notification": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/NotificationBase"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "read_state": {
+                "type": "boolean",
+                "example": false
+              },
+              "visibility_user_ids": {
+                "description": "The person who is the corresponding event recipient.",
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "example": [
+                  "1",
+                  "2",
+                  "3",
+                  "4",
+                  "5"
+                ]
+              }
+            }
+          }
+        ]
+      },
+      "NotificationBase": {
+        "type": "object",
+        "properties": {
+          "notification_id": {
+            "type": "number"
+          },
+          "timestamp": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "type": {
+            "description": "Type of notification",
+            "type": "string",
+            "example": "workflow"
+          },
+          "redirect_url": {
+            "description": "Redirect url",
+            "type": "string",
+            "example": "https://epilot.cloud"
+          },
+          "organization_id": {
+            "description": "Organization Id",
+            "type": "string",
+            "example": "206801"
+          },
+          "title": {
+            "type": "object",
+            "properties": {
+              "en": {
+                "type": "string",
+                "description": "Title for notification. Supports handlebars syntax.",
+                "example": "My custom notification"
+              },
+              "de": {
+                "type": "string",
+                "description": "Title for notification. Supports handlebars syntax.",
+                "example": "Meine benutzerdefinierte Aktivität"
+              }
+            }
+          },
+          "message": {
+            "type": "object",
+            "properties": {
+              "en": {
+                "type": "string",
+                "description": "Message for notification. Supports handlebars syntax.",
+                "example": "{{caller}} did something with {{contact.entity.id}} {{branch.name}}."
+              },
+              "de": {
+                "type": "string",
+                "description": "Message for notification. Supports handlebars syntax.",
+                "example": "{{caller}} habe etwas damit gemacht {{contact.entity.id}} {{branch.name}}."
+              }
+            }
+          },
+          "payload": {
+            "type": "object",
+            "properties": {},
+            "additionalProperties": true,
+            "example": {
+              "entity": {
+                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+                "schema": "contact"
+              }
+            }
+          },
+          "caller": {
+            "$ref": "#/components/schemas/NotificationCallerContext"
+          },
+          "operations": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/EntityOperation"
+            }
+          },
+          "force_notify_users": {
+            "type": "object",
+            "properties": {},
+            "additionalProperties": true,
+            "example": {
+              "12345": {
+                "email": false,
+                "in_app": false
+              }
+            }
+          }
+        },
+        "required": [
+          "type",
+          "title",
+          "message"
+        ]
+      },
+      "EntityId": {
+        "type": "string",
+        "format": "uuid"
+      },
+      "Entity": {
+        "type": "object",
+        "properties": {},
+        "additionalProperties": true
+      },
+      "Id": {
+        "type": "number",
+        "example": 123456789
+      },
+      "NotificationId": {
+        "type": "number",
+        "example": 123456789
+      },
+      "NotificationCallerContext": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "EpilotAuth": {
+            "type": "object",
+            "properties": {
+              "token": {
+                "type": "object",
+                "properties": {
+                  "sub": {
+                    "type": "string",
+                    "example": "476e9b48-42f4-4234-a2b0-4668b34626ce"
+                  },
+                  "email": {
+                    "type": "string",
+                    "example": "example@epilot.cloud"
+                  },
+                  "cognito:username": {
+                    "type": "string",
+                    "example": "example@epilot.cloud"
+                  },
+                  "custom:ivy_user_id": {
+                    "type": "string",
+                    "example": "10006129"
+                  }
+                },
+                "example": {
+                  "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",
+                  "cognito:groups": [
+                    "Administrator"
+                  ],
+                  "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",
+                  "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",
+                  "custom:ivy_org_id": "739224",
+                  "cognito:username": "n.ahmad@epilot.cloud",
+                  "custom:ivy_user_id": "10006129",
+                  "cognito:roles": [
+                    "arn:aws:iam::912468240823:role/base-administrator-role"
+                  ],
+                  "aud": "6e0jbdnger7nmoktaaflarue1l",
+                  "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",
+                  "token_use": "id",
+                  "auth_time": 1614333023,
+                  "exp": 1614336623,
+                  "iat": 1614333023,
+                  "email": "n.ahmad@epilot.cloud"
+                }
+              }
+            }
+          }
+        }
+      },
+      "EntitySlug": {
+        "description": "URL-friendly identifier for the entity schema",
+        "type": "string",
+        "example": "contact"
+      },
+      "EntityOwner": {
+        "type": "object",
+        "required": [
+          "org_id",
+          "user_id"
+        ],
+        "properties": {
+          "org_id": {
+            "type": "string",
+            "description": "Organization ID"
+          },
+          "user_id": {
+            "type": "string",
+            "description": "User ID"
+          }
+        }
+      },
+      "EntityAcl": {
+        "type": "object",
+        "description": "Access control list",
+        "properties": {
+          "view": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "edit": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "delete": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "NotificationTemplate": {
+        "type": "object",
+        "required": [
+          "_id",
+          "_org",
+          "_schema",
+          "_title",
+          "_created_at",
+          "_updated_at"
+        ],
+        "properties": {
+          "_id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Unique identifier"
+          },
+          "_schema": {
+            "type": "string",
+            "description": "Entity schema type"
+          },
+          "_title": {
+            "type": "string",
+            "nullable": true,
+            "description": "Display title"
+          },
+          "_org": {
+            "type": "string",
+            "description": "Organization ID"
+          },
+          "_tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "nullable": true,
+            "description": "Tags for categorization"
+          },
+          "_created_at": {
+            "type": "string",
+            "format": "date-time",
+            "nullable": true,
+            "description": "ISO timestamp of creation"
+          },
+          "_updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "nullable": true,
+            "description": "ISO timestamp of last update"
+          },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest ID used to create/update the entity",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            }
+          },
+          "_owners": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/EntityOwner"
+            },
+            "description": "Entity owners",
+            "readOnly": true
+          },
+          "_acl": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/EntityAcl"
+              }
+            ],
+            "description": "Access control list",
+            "readOnly": true
+          },
+          "name": {
+            "type": "string",
+            "description": "Internal template name"
+          },
+          "type": {
+            "type": "string",
+            "description": "Notification type key"
+          },
+          "notification_title": {
+            "type": "string",
+            "description": "Notification title (Lexical editor JSON, supports variables)"
+          },
+          "message": {
+            "type": "string",
+            "description": "Notification body (Lexical editor JSON, supports variables)"
+          },
+          "action_label": {
+            "type": "string",
+            "description": "CTA button text (supports variables)"
+          },
+          "action_url": {
+            "type": "string",
+            "description": "CTA button URL (supports variables)"
+          },
+          "style": {
+            "type": "string",
+            "description": "JSON string with style config"
+          },
+          "system_template": {
+            "type": "boolean",
+            "description": "Whether this is a system template",
+            "readOnly": true
+          },
+          "created_by": {
+            "type": "string",
+            "description": "User ID who created the template",
+            "readOnly": true
+          },
+          "updated_by": {
+            "type": "string",
+            "description": "User ID who last updated the template",
+            "readOnly": true
+          }
+        }
+      },
+      "CreateNotificationTemplateInput": {
+        "type": "object",
+        "required": [
+          "name",
+          "type"
+        ],
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Internal template name (required)"
+          },
+          "type": {
+            "type": "string",
+            "description": "Notification type key (required)"
+          },
+          "notification_title": {
+            "type": "string",
+            "description": "Notification title (Lexical editor JSON, supports variables)"
+          },
+          "message": {
+            "type": "string",
+            "description": "Notification body (Lexical editor JSON, supports variables)"
+          },
+          "action_label": {
+            "type": "string",
+            "description": "CTA button text (supports variables)"
+          },
+          "action_url": {
+            "type": "string",
+            "description": "CTA button URL (supports variables)"
+          },
+          "style": {
+            "type": "string",
+            "description": "JSON string with style config"
+          },
+          "_title": {
+            "type": "string",
+            "description": "Display title"
+          },
+          "_tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Tags for categorization"
+          },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest ID used to create/update the entity",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            }
+          }
+        }
+      },
+      "UpdateNotificationTemplateInput": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Internal template name"
+          },
+          "notification_title": {
+            "type": "string",
+            "description": "Notification title (Lexical editor JSON, supports variables)"
+          },
+          "message": {
+            "type": "string",
+            "description": "Notification body (Lexical editor JSON, supports variables)"
+          },
+          "action_label": {
+            "type": "string",
+            "description": "CTA button text (supports variables)"
+          },
+          "action_url": {
+            "type": "string",
+            "description": "CTA button URL (supports variables)"
+          },
+          "style": {
+            "type": "string",
+            "description": "JSON string with style config"
+          },
+          "_title": {
+            "type": "string",
+            "description": "Display title"
+          },
+          "_tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Tags for categorization"
+          },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest ID used to create/update the entity",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            }
+          }
+        }
+      },
+      "NotificationTemplateListResponse": {
+        "type": "object",
+        "properties": {
+          "results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/NotificationTemplate"
+            }
+          },
+          "hits": {
+            "type": "integer",
+            "description": "Total number of matching results"
+          }
+        }
+      },
+      "SendPreviewInput": {
+        "type": "object",
+        "required": [
+          "template"
+        ],
+        "properties": {
+          "template": {
+            "$ref": "#/components/schemas/UpdateNotificationTemplateInput"
+          },
+          "context_ids": {
+            "type": "object",
+            "description": "Optional context IDs for variable replacement",
+            "additionalProperties": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "SendPreviewResponse": {
+        "type": "array",
+        "description": "Array of results for each notification channel (email, in-app)",
+        "items": {
+          "type": "object",
+          "required": [
+            "success"
+          ],
+          "properties": {
+            "success": {
+              "type": "boolean",
+              "description": "Whether this notification was sent successfully"
+            },
+            "data": {
+              "description": "Result data"
+            }
+          }
+        }
+      }
+    }
+  },
+  "servers": [
+    {
+      "url": "https://notification.sls.epilot.io"
+    }
+  ]
+}