Skip to main content
GET
/
api
/
v1
/
web-integrations
/
integration
Get web integration
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://blackbox.dasha.ai/api/v1/web-integrations/integration', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "agentId": "<string>",
  "name": "<string>",
  "enabled": true,
  "features": [
    {
      "name": "AllowWebCall",
      "enabled": true
    }
  ],
  "widgetAppearance": {
    "theme": "<string>",
    "position": "<string>",
    "colors": {},
    "customStyles": {}
  },
  "integrationId": "<string>",
  "orgId": "<string>",
  "createdTime": "2023-11-07T05:31:56Z",
  "lastUpdateTime": "2023-11-07T05:31:56Z",
  "tokens": [
    {
      "tokenId": "<string>",
      "name": "<string>",
      "token": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z",
      "lastUsedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "description": "<string>",
  "origins": [
    "<string>"
  ],
  "tools": [
    "<string>"
  ]
}

Query Parameters

​
integrationId
string

Integration identifier

Response

Returns web integration successfully

Web integration response including all configuration and metadata

​
agentId
string
required

Agent ID to associate with this web integration. The agent handles all conversations initiated through this integration.

Minimum string length: 1
​
name
string
required

Integration name for identification purposes. Allowed characters: letters, numbers, hyphens, underscores, and spaces.

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9\-_ ]+$
​
enabled
boolean
required

Whether this integration is active. Disabled integrations cannot be used for new conversations.

​
features
object[]
required

Enabled features for this integration. Controls capabilities like web calls, chat, phone calls, and result delivery.

​
widgetAppearance
object
required

Widget appearance configuration including theme, position, colors, and custom styles for the embedded chat widget.

​
integrationId
string
required

Unique integration identifier

Minimum string length: 1
​
orgId
string
required

Organization ID that owns this integration

Minimum string length: 1
​
createdTime
string<date-time>
required

Integration creation timestamp

​
lastUpdateTime
string<date-time>
required

Last modification timestamp

​
tokens
object[]
required

Access tokens associated with this integration. Tokens are used to authenticate websocket connections.

​
description
string | null

Description of the integration's purpose or usage context.

Maximum string length: 500
​
origins
string[] | null

Allowed origins for CORS security. Controls which websites can access this integration. If empty or null, all origins are allowed. Supported formats: "" (all origins), full HTTP/HTTPS URLs ("https://example.com", "http://localhost:3000"), wildcard subdomains (".example.com"), or domain names ("example.com"). Ports can only be specified in full URLs, not with domain names or wildcards.

​
tools
string[] | null

Tool names that should be executed via websocket by the client. When the agent needs to use these tools during a conversation, it sends a websocketToolRequest message to the client, and the client must execute the tool and return the result via websocketToolResponse. If not specified, all tools are executed server-side.