Docs
Open SmallForce

CLI

smallforce integrations events configure

Create or update a rule for one connected-account event

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run smallforce integrations events configure --help locally to view the same reference for your installed version.

Complete command help

Usage: smallforce integrations events configure [options] [eventSlug]

Create or update a rule for one connected-account event

Arguments:
  eventSlug                   Event slug returned by integrations events list

Options:
  --event <slug>              Event slug, useful when omitting the argument
  --connection <id>           SmallForce connection id
  --profile <slug>            Target SmallForce profile slug
  --instructions <text>       Instructions for handling this event
  --instructions-file <path>  File containing event handling instructions, or - for stdin
  --chat <strategy>           Which chat events go to: connection (one per account), event (one per
                              subject), fixed, or new
  --target-chat <chatId>      Required when --chat fixed
  --include-payload           Include provider event payload in the rule
  --event-config <json>       Inline JSON object for event config
  --event-config-file <path>  JSON file containing event config, or - for stdin
  --api-key <key>             SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>         SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                      Print stable machine-readable JSON
  --text                      Print human-readable text
  --format <format>           Output format: text or json
  -h, --help                  display help for command