Open Inventory / Docs
EndpointsNotificationsNotificationsTest

Preview one delivery channel without sending

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

POST
/notifications/test

Dry-run only. This endpoint never invokes SMTP, Web Push, Slack, Teams, or generic webhook transports.

Authorization

adminSession
cookieauthjs.session-token<token>

Authenticated Auth.js browser session cookie; each operation declares its required permission. Not restricted to administrators. HTTPS deployments use the secure-prefixed cookie variant.

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Request Body

application/json
  1. body
channel*string
Value in"email""push""slack""teams""webhook"

Response Body

Redacted sample payload with dryRun true

Example Request
curl -X POST 'https://inventory.example.com/api/v1/notifications/test' \  -H 'Content-Type: application/json' \  -d '{  "channel": "email"}'
Example Response200
Empty

Run notification detection and due digest dispatch POST

Invokes one deduplicated detector/dispatcher cycle. Authenticate with `Authorization: Bearer NOTIFICATION_CRON_SECRET`, or with an authenticated browser session that has `tokens.manage`. Safe retries rely on cooldown, inbox uniqueness, and dispatch dedupe keys.

List purchase, sales, or loan orders from the shared order model GET

Next Page