KosmoKrator

communication

Novu CLI for CI

Use the Novu CLI for CI with headless JSON commands, schema discovery, credentials, and permission controls.

7 functions 5 read 2 write API key auth

Novu CLI for CI

Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status.

Use this shape when a pipeline needs to read or update an external service. The Novu CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.

Command Shape

# Novu CLI for CI
kosmokrator integrations:configure novu --set api_key="$NOVU_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call novu.novu_list_notifications '{"page":1,"limit":1,"channel":"example_channel"}' --json

Discovery Before Execution

Agents and scripts can inspect Novu docs and schemas before choosing a function.

kosmo integrations:docs novu --json
kosmo integrations:docs novu.novu_list_notifications --json
kosmo integrations:schema novu.novu_list_notifications --json
kosmo integrations:search "Novu" --json
kosmo integrations:list --json

Useful Novu CLI Functions

FunctionTypeParametersDescription
novu.novu_list_notifications Read page, limit, channel List notifications from Novu. Returns a paginated list of notifications, optionally filtered by channel (e.g., in_app, email, sms, chat, push).
novu.novu_get_notification Read id Get details of a specific notification in Novu by its ID. Returns the full notification object including status, channel data, and content.
novu.novu_list_subscribers Read page, limit List subscribers from Novu. Returns a paginated list of all notification subscribers with their details.
novu.novu_get_subscriber Read id Get details of a specific subscriber in Novu by their ID. Returns the subscriber profile including email, phone, and preferences.
novu.novu_create_subscriber Write email, firstName, lastName, phone Create a new subscriber in Novu. Requires an email address. Optionally include first name, last name, and phone number.
novu.novu_trigger_event Write name, to, payload Trigger a notification event in Novu. Sends a notification based on a workflow template to one or more subscribers. The "to" field can be a subscriber ID, email address, or an array of recipients.
novu.novu_get_current_user Read none Get the currently authenticated Novu user. Returns user profile information including name, email, and organization details.

Automation Notes

Related Novu CLI Pages