Get widget settings

Get an agent's website voice widget settings (orb or button), with defaults filled in.

GET https://api.centerfy.ai/webhooks/inbound/agents/:id/widget

Headers

Header	Required	Value	Description
`x-api-key`	Yes	your sub-account API key (cfy_…)	Authenticates the request; or use Authorization: Bearer `<key>`.

Path parameters

Name	Type	Required	Description
`id`	`string (uuid)`	Yes	The agent id.

Example

curl -X GET "https://api.centerfy.ai/webhooks/inbound/agents/{id}/widget" \
  -H "x-api-key: $CENTERFY_API_KEY"

import { CenterfyClient } from "@centerfy/sdk";

const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });

const result = await centerfy.agentWidget.get("<agentId>");
console.log(result);

centerfy agentWidget get <agentId>

MCP tool: centerfy_agent_widget_get (see MCP server)

Response

{
  "status": "success",
  "agent_id": "0f1e2d3c-4b5a-4968-8776-655443322110",
  "name": "Front desk",
  "widget_config": {
    "type": "orb",
    "orb": {
      "icon": "mic",
      "color": "#00c8ff",
      "size": 60,
      "show_border": true,
      "show_text_below": false,
      "cta_text": "Chat with us!",
      "text_color": "#ffffff",
      "background_style": "dark"
    }
  }
}

Errors

404 — if the agent is not in this sub-account.

Notes

An agent that was never configured returns the default orb shown above. Missing orb settings are filled with the defaults.