KosmoKrator

marketing

Braze CLI for Coding Agents

Use the Braze CLI for coding agents with headless JSON commands, schema discovery, credentials, and permission controls.

7 functions 7 read 0 write API key auth

Braze CLI for Coding Agents

Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

Use this pattern when another coding agent needs exact commands and schema discovery. The Braze CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.

Command Shape

# Braze CLI for Coding Agents
kosmokrator integrations:configure braze --set api_key="$BRAZE_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call braze.braze_list_campaigns '{"page":1,"limit":1}' --json

Discovery Before Execution

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

kosmo integrations:docs braze --json
kosmo integrations:docs braze.braze_list_campaigns --json
kosmo integrations:schema braze.braze_list_campaigns --json
kosmo integrations:search "Braze" --json
kosmo integrations:list --json

Useful Braze CLI Functions

FunctionTypeParametersDescription
braze.braze_list_campaigns Read page, limit List marketing campaigns from Braze. Returns campaign IDs, names, tags, and creation dates. Use pagination to browse large numbers of campaigns.
braze.braze_get_campaign Read campaign_id Get detailed information about a specific Braze campaign, including targeting rules, messaging content, schedule, and analytics.
braze.braze_list_canvases Read page, limit List canvases (multi-step customer journeys) from Braze. Returns canvas IDs, names, tags, and creation dates. Use pagination to browse large result sets.
braze.braze_get_canvas Read canvas_id Get detailed information about a specific Braze canvas, including steps, targeting rules, messaging channels, and analytics.
braze.braze_list_users Read external_ids, segment_id, limit Export users from Braze by segment ID or external IDs. Returns user profile data including attributes and subscription state. Provide either a segment_id to get users in a segment, or external_ids to look up specific users.
braze.braze_get_user Read external_ids Get a single user profile from Braze by their external ID. Returns full profile data including attributes, custom attributes, events, purchases, and subscription groups.
braze.braze_get_current_user Read none Get the current authenticated Braze user profile. Useful for verifying credentials and identifying the connected workspace.

Automation Notes

Related Braze CLI Pages