Web Chat Channels

A web chat channel is one chat widget. These endpoints read your channels: their status, the websites they may run on, the snippet to paste, when the chat was last seen on your site, and the AI assistant linked to them. Channels are created and edited in the dashboard. See Install web chat on your website.

Scope and access

Needs web_chat:read on scoped keys. Web chat must be on for your account, otherwise every web chat endpoint answers 403 WEB_CHAT_NOT_ENABLED.

List Web Chat Channels

Returns every web chat channel on your account, oldest first. Deleted channels are left out. There is no paging.

GET/v2.0/web-chat/channels

Code Example

curl -X GET "https://api.sendiee.com/v2.0/web-chat/channels" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response — 200 OK

{
  "success": true,
  "data": [
    {
      "id": "6720b1c09d2b4e0011ab5501",
      "name": "Main website",
      "publicKey": "wc_k3mq7xr2vd5tpa6nwe4h",
      "status": "active",
      "allowedDomains": [
        "kesariloom.in",
        "*.kesariloom.in"
      ],
      "install": {
        "snippet": "<script src=\"https://cdn.sendiee.com/chat.v1.js\" data-channel=\"wc_k3mq7xr2vd5tpa6nwe4h\" async></script>",
        "lastSeenHost": "www.kesariloom.in",
        "lastSeenAt": "2026-11-07T09:12:44.000Z"
      },
      "assistant": {
        "id": "6721c3d09d2b4e0011ab6601",
        "name": "Kesari helper",
        "isActive": true
      },
      "teamId": "671f0a2b9d2b4e0011ab4401",
      "liveVisitorsTracking": true,
      "createdAt": "2026-11-01T06:30:00.000Z",
      "updatedAt": "2026-11-06T11:02:18.000Z"
    },
    {
      "id": "6722d4e19d2b4e0011ab5502",
      "name": "Hindi site",
      "publicKey": "wc_b7fz2qcu6mh3ks4yro5p",
      "status": "paused",
      "allowedDomains": [
        "hi.kesariloom.in"
      ],
      "install": {
        "snippet": "<script src=\"https://cdn.sendiee.com/chat.v1.js\" data-channel=\"wc_b7fz2qcu6mh3ks4yro5p\" async></script>",
        "lastSeenHost": null,
        "lastSeenAt": null
      },
      "assistant": null,
      "teamId": null,
      "liveVisitorsTracking": false,
      "createdAt": "2026-11-03T08:00:00.000Z",
      "updatedAt": "2026-11-03T08:00:00.000Z"
    }
  ]
}

Channel Object

Parameter	Type	Required	Description
id	string	Optional	The channel id. Use it in the other web chat paths
name	string	Optional	The channel name your team sees in the dashboard
publicKey	string	Optional	The channel key, wc_ followed by 20 characters. Public: it goes in the snippet
status	string	Optional	active, or paused. A paused channel is hidden on your website
allowedDomains	string[]	Optional	Websites the chat may open on. A *.example.com entry covers every subdomain but not example.com itself
install.snippet	string	Optional	The line of code to paste on every page, just before </body>
install.lastSeenHost	string \| null	Optional	The allowed website where the chat last loaded, or null if never
install.lastSeenAt	string (ISO 8601) \| null	Optional	When the chat last loaded there. Updated at most once every 10 minutes per website
assistant	object \| null	Optional	The AI assistant with platform web linked to this channel: { id, name, isActive }. null when there is none. An active one is preferred when several point at the channel
teamId	string \| null	Optional	The team that gets new chats when your routing rules don't place them
liveVisitorsTracking	boolean	Optional	The channel's Track live visitors switch
createdAt	string (ISO 8601)	Optional	When the channel was created
updatedAt	string (ISO 8601)	Optional	When the channel was last changed

Checking an install from your own tools

After you paste the snippet, poll this endpoint and wait for install.lastSeenAt to change. It only records pages on the channel’s allowed websites, opened on https://.

Try It — List Channels

Try it — API Playground

API Key

Get a Web Chat Channel

Returns one channel, in the same shape as the list.

GET/v2.0/web-chat/channels/{channelId}

Path Parameters

Parameter	Type	Required	Description
channelId	string	Required	The channel id from List Web Chat Channels

Code Example

curl -X GET "https://api.sendiee.com/v2.0/web-chat/channels/6720b1c09d2b4e0011ab5501" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response — 200 OK

{
  "success": true,
  "data": {
    "id": "6720b1c09d2b4e0011ab5501",
    "name": "Main website",
    "publicKey": "wc_k3mq7xr2vd5tpa6nwe4h",
    "status": "active",
    "allowedDomains": [
      "kesariloom.in",
      "*.kesariloom.in"
    ],
    "install": {
      "snippet": "<script src=\"https://cdn.sendiee.com/chat.v1.js\" data-channel=\"wc_k3mq7xr2vd5tpa6nwe4h\" async></script>",
      "lastSeenHost": "www.kesariloom.in",
      "lastSeenAt": "2026-11-07T09:12:44.000Z"
    },
    "assistant": {
      "id": "6721c3d09d2b4e0011ab6601",
      "name": "Kesari helper",
      "isActive": true
    },
    "teamId": "671f0a2b9d2b4e0011ab4401",
    "liveVisitorsTracking": true,
    "createdAt": "2026-11-01T06:30:00.000Z",
    "updatedAt": "2026-11-06T11:02:18.000Z"
  }
}

Errors

A malformed id, another account’s channel and a deleted channel all answer 404 CHANNEL_NOT_FOUND. See the errors every web chat endpoint can return.