KosmoKrator

communication

Courier CLI for CI

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

7 functions 6 read 1 write API key auth

Courier 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 Courier CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.

Command Shape

# Courier CLI for CI
kosmokrator integrations:configure courier --set api_key="$COURIER_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call courier.courier_send_message '{"message":"example_message","recipient":"example_recipient"}' --json

Discovery Before Execution

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

kosmo integrations:docs courier --json
kosmo integrations:docs courier.courier_send_message --json
kosmo integrations:schema courier.courier_send_message --json
kosmo integrations:search "Courier" --json
kosmo integrations:list --json

Useful Courier CLI Functions

FunctionTypeParametersDescription
courier.courier_send_message Write message, recipient Send a notification message through Courier. Provide a message payload with content or template, and a recipient (user ID, email, or recipient object). Supports all Courier send options including channels, routing, and preferences.
courier.courier_list_messages Read limit, cursor, status List messages from Courier with optional filtering by status and cursor-based pagination. Returns message IDs, statuses, and metadata.
courier.courier_get_message Read id Get detailed information about a specific Courier message, including delivery status, content, and channel details.
courier.courier_list_recipients Read limit, cursor List notification recipients from Courier with cursor-based pagination. Returns recipient IDs, contact details, and preferences.
courier.courier_get_recipient Read id Get detailed information about a specific Courier recipient, including contact preferences and channel profiles.
courier.courier_list_templates Read limit, cursor List notification templates from Courier with cursor-based pagination. Returns template IDs, names, and metadata.
courier.courier_get_current_user Read none Get the currently authenticated Courier user profile. Use this to verify the API key and see account information.

Automation Notes

Related Courier CLI Pages