Docs

Tools: configuration

8 tool(s) in this category.

console.crm_mappings.get

Get CRM Stage Mappings

Read the business's current CRM mappings configuration: deal-stage mappings (raw CRM stage → normalized pipeline stage) and deal-amount tiers, plus version and applied_version stamps. Use when the caller needs to understand how CRM deal stages are being normalized before querying pipeline data, audit the current mapping set, or compare saved vs applied versions to check pipeline convergence.

  • HTTP: (not exposed as REST)
  • Required scopes: config:read
  • Required role: viewer
  • Stability: stable
  • Version: 1.0

Input

No structured input.

console.data_filters.get

Get Data Filter Rules

Read the business's current data-filter configuration: the full rules array plus version and applied_version stamps. Use when the caller needs to inspect which source/category/entity exclusions are active, compare the saved version against the pipeline's applied version, or audit what data is excluded before querying. Returns the empty-config default (version 0, rules []) when no row exists yet.

  • HTTP: (not exposed as REST)
  • Required scopes: config:read
  • Required role: viewer
  • Stability: stable
  • Version: 1.0

Input

No structured input.

prompts.settings.warm_workspace

Warm Workspace Prompt

Use when first orienting on a workspace (new session, new tenant, new client). Explains that the slow-to-load background pipelines — business profile discovery, author voice summaries, brand voice summary — are primed automatically on connect, so no warm tool call is needed. Directs the agent to read the profile via context.summary and proceed without blocking on background jobs.

  • HTTP: (not exposed as REST)
  • Required scopes: config:read
  • Required role: viewer
  • Stability: stable
  • Version: 1.0
  • Tags: prompt, settings, warmup

Input

No structured input.

prompts.webhook.debug_delivery

Debug Webhook Delivery Prompt

Use when the user reports trouble with a specific webhook subscription and wants a delivery diagnosis. Directs the agent to fetch the webhook config, pull recent deliveries across all statuses, and distinguish transient from systemic failures.

  • HTTP: (not exposed as REST)
  • Required scopes: webhooks:read
  • Required role: viewer
  • Stability: stable
  • Version: 1.0
  • Tags: prompt, webhook, debug

Input

FieldTypeRequiredDescription
webhook_idstringyesUUID of the webhook subscription.

prompts.webhook.webhook_health_check

Webhook Health Check Prompt

Use when the user asks for a health check across webhook subscriptions. Directs the agent to list every webhook, pull recent failed deliveries for each, and produce a ranked report highlighting which endpoints need attention.

  • HTTP: (not exposed as REST)
  • Required scopes: webhooks:read
  • Required role: viewer
  • Stability: stable
  • Version: 1.0
  • Tags: prompt, webhook, observability

Input

No structured input.

webhook.get

Get Webhook

Fetch a single webhook subscription by UUID. Use when the caller knows the subscription id and wants its configuration (URL, event filters, status). Secrets are never returned.

  • HTTP: (not exposed as REST)
  • Required scopes: webhooks:read
  • Required role: viewer
  • Stability: stable
  • Version: 1.0

Input

FieldTypeRequiredDescription
idstringyes

webhook.list

List Webhooks

List outbound webhook subscriptions for this business. Use when auditing registered subscriptions or checking which endpoints the platform currently fans events out to. Pass active_only=false to include disabled subscriptions; secrets are never returned.

  • HTTP: (not exposed as REST)
  • Required scopes: webhooks:read
  • Required role: viewer
  • Stability: stable
  • Version: 1.0

Input

FieldTypeRequiredDescription
active_onlystringno
limitintegerno
offsetintegerno

webhook.list_deliveries

List Webhook Deliveries

List delivery attempts for a specific webhook subscription. Use when debugging failures, inspecting retry history, or confirming that recent events reached the configured endpoint. Filter by status (success|failed|pending); paginate via limit + offset.

  • HTTP: (not exposed as REST)
  • Required scopes: webhooks:read
  • Required role: viewer
  • Stability: stable
  • Version: 1.0

Input

FieldTypeRequiredDescription
idstringyes
statusstringno
limitintegerno
offsetintegerno