Widgets

Add someone for a widget to ring: either a team member (rung through their browser softphone) or an arbitrary phone number. Agents are rung in the order they were added when the dial strategy is sequential.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.add_agent \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "widget_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool widgets_add_agent at https://app.chirply.io/api/mcp, same bearer token, same input.

Allow a website to embed a widget. The widget only renders (and its public config API only responds) on origins in this list, so add every host it should appear on — apex, www and staging.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.add_origin \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "widget_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "origin": "example"
  }'

Over MCP the same operation is the tool widgets_add_origin at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a draft click-to-call widget with default copy and weekday 9–5 availability, and mint its public embed key. It renders nowhere until you add allowed sites and publish it.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.create \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example"
  }'

Over MCP the same operation is the tool widgets_create at https://app.chirply.io/api/mcp, same bearer token, same input.

PERMANENTLY DESTROY a widget along with its schedule, agent routing, allowed origins and visitor session history. Any embed snippet still installed on the tenant's site stops working. This cannot be undone.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.delete \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool widgets_delete at https://app.chirply.io/api/mcp, same bearer token, same input.

Get the one-line script tag that installs a CLICK-TO-CALL widget — paste it into the site's HTML just before </body> — plus the widget's standalone iframe URL. The button only appears on origins added with widgets.add_origin. This returns the click-to-call loader (/embed/w.js and /w/<key>); a live-chat widget needs a DIFFERENT loader and would be inert with this one, so a chat widget's id returns not-found here — use live_chat.embed_snippet for those.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.embed_snippet \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool widgets_embed_snippet at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch one CLICK-TO-CALL widget with everything its builder shows: behavior and appearance settings, business hours, the agents it rings, the sites it's allowed to appear on, and the embed snippet. Click-to-call only — a live-chat widget's id returns not-found here, because its settings are a different shape entirely; read those with live_chat.get_widget.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.get \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool widgets_get at https://app.chirply.io/api/mcp, same bearer token, same input.

List the organization's embeddable click-to-call widgets — the floating button that rings agents and bridges a website visitor without exposing anyone's number.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool widgets_list at https://app.chirply.io/api/mcp, same bearer token, same input.

MAKE THIS WIDGET LIVE ON THE TENANT'S WEBSITE. Once published, the embed snippet renders the floating button to real visitors on every allowed origin, and a visitor pressing it will originate real calls or texts to the configured agents. Add allowed sites first — an unpublished or origin-less widget renders nowhere.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.publish \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool widgets_publish at https://app.chirply.io/api/mcp, same bearer token, same input.

Stop a widget ringing a particular team member or number. Removing the last agent leaves the widget with nobody to connect visitors to.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.remove_agent \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool widgets_remove_agent at https://app.chirply.io/api/mcp, same bearer token, same input.

Stop a widget from rendering on a site. THIS BREAKS A WORKING INSTALL: the button vanishes from that website for real visitors on the loader's next refresh — the embed snippet is still in their HTML, so it looks installed and simply does nothing — and its public config API stops answering for that origin. Visitors on that site can no longer request a call or text. Re-adding the origin with widgets.add_origin restores it.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.remove_origin \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "origin_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool widgets_remove_origin at https://app.chirply.io/api/mcp, same bearer token, same input.

Set the timezone and per-day availability window for a widget. Outside these hours the widget offers a scheduled callback instead of ringing agents.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.save_schedule \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "widget_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "timezone": "example",
    "hours": {
      "mon": {
        "enabled": true,
        "start": "example",
        "end": "example"
      },
      "tue": {
        "enabled": true,
        "start": "example",
        "end": "example"
      },
      "wed": {
        "enabled": true,
        "start": "example",
        "end": "example"
      },
      "thu": {
        "enabled": true,
        "start": "example",
        "end": "example"
      },
      "fri": {
        "enabled": true,
        "start": "example",
        "end": "example"
      },
      "sat": {
        "enabled": true,
        "start": "example",
        "end": "example"
      },
      "sun": {
        "enabled": true,
        "start": "example",
        "end": "example"
      }
    }
  }'

Over MCP the same operation is the tool widgets_save_schedule at https://app.chirply.io/api/mcp, same bearer token, same input.

Take a widget off the tenant's website. The button stops rendering for visitors and the public config API stops responding for it, even where the embed snippet is still installed. Configuration is kept — publish again to restore it.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.unpublish \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool widgets_unpublish at https://app.chirply.io/api/mcp, same bearer token, same input.

Update a widget's name, dialing behavior, which devices it shows on, and its appearance/copy settings. If the widget is published these changes are visible on the tenant's live site immediately. Omitted fields are left alone.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/widgets.update \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool widgets_update at https://app.chirply.io/api/mcp, same bearer token, same input.