GET /widget/conversations/inbox_config

The inbox_config endpoint returns the complete configuration for a web widget inbox. The widget calls this endpoint every time the chat bubble is opened, so any changes made in the Chatwoot dashboard — such as enabling or disabling the ElevenLabs voice agent — take effect on the next bubble click without requiring a page reload.

Endpoint

GET /api/v1/widget/conversations/inbox_config

Authentication

This endpoint does not require an agent session. It identifies the inbox using the website_token query parameter, which is the token from your widget embed script.

The website_token is available from the Chatwoot dashboard under Settings → Inboxes → your inbox → Configuration → Installation. It is embedded in the <script> tag you add to your site.

Query parameters

website_token

string

required

The website token that identifies the web widget inbox. This value comes from the widget embed script tag and uniquely maps the request to the correct inbox and its channel configuration.

Response

A successful response returns HTTP 200 with a JSON body structured as { payload: { inbox: { ... } } }.

payload

object

Top-level wrapper object.

Show properties

inbox

object

The inbox object containing identity and all voice agent configuration fields.

Show properties

number

The numeric ID of the inbox in Chatwoot.

name

string

The display name of the inbox as configured in the Chatwoot dashboard.

selected_feature_flags

string[]

Array of feature flag strings that are enabled for this inbox. When the ElevenLabs voice agent is active, this array includes "elevenlabs_voice". The legacy value "voice_agent" is also accepted by the widget for backwards compatibility.

voice_agent_provider

string

The voice provider configured for this inbox. Currently "elevenlabs" is the supported value. Defaults to "elevenlabs" if not explicitly set.

voice_agent_api_key

string

The API key for the configured voice provider. For public ElevenLabs agents this field may be an empty string — public agents do not require an API key in the widget. For private agents, this key is used server-side to obtain a signed URL via the voice_signed_url endpoint and is never forwarded to the browser.

voice_agent_config_data

object

A configuration object containing agent-specific settings. The widget reads agent_id, voice_id, and agent_name from this object.

Show properties

agent_id

string

The ElevenLabs agent ID. Takes precedence over elevenlabs_agent_id in the widget’s resolution order.

voice_id

string

The ElevenLabs voice ID to use for this agent.

agent_name

string

A human-readable name for the voice agent, displayed in the widget UI.

elevenlabs_agent_id

string

The ElevenLabs agent ID stored in its own dedicated column. The widget uses this as a fallback if voice_agent_config_data.agent_id is not present. In most configurations both fields hold the same value since the dashboard writes to both simultaneously.

Example request

curl "https://your-chatwoot-domain.com/api/v1/widget/conversations/inbox_config?website_token=YOUR_WEBSITE_TOKEN"

Example response

{
  "payload": {
    "inbox": {
      "id": 3,
      "name": "Support Widget",
      "selected_feature_flags": ["elevenlabs_voice"],
      "voice_agent_provider": "elevenlabs",
      "voice_agent_api_key": "",
      "voice_agent_config_data": {
        "agent_id": "agent_01jxample000000000000000",
        "voice_id": "voice_01jxample000000000000000",
        "agent_name": "AI Assistant"
      },
      "elevenlabs_agent_id": "agent_01jxample000000000000000"
    }
  }
}

Notes

The widget dispatches voiceAgentConfig/fetchVoiceAgentConfig on every chat bubble open event. This means dashboard changes to voice agent settings take effect on the visitor’s next widget open without a page reload.

The voice button in the widget is shown only when all three conditions are met: selected_feature_flags includes "elevenlabs_voice", voice_agent_provider is "elevenlabs", and an agent_id is present in either voice_agent_config_data or elevenlabs_agent_id.

Widget API

GET /widget/conversations/inbox_config

Endpoint

Authentication

Query parameters

Response

Example request

Example response

Notes

Build docs developers (and LLMs) love

Widget API

Documentation Index

​Endpoint

​Authentication

​Query parameters

​Response

​Example request

​Example response

​Notes

Build docs developers (and LLMs) love

Endpoint

Authentication

Query parameters

Response

Example request

Example response

Notes