Sign in
Agent Connectors

List agent connectors

Lists all connectors on an alias, with optional filtering and pagination.

get/v2/agent_aliases/{alias_key}/connectors

Path parameters

alias_keystring required

The unique key that identifies an alias. Alias keys are independent of agent keys. The same string can exist as both an alias key and an agent key in the same customer account. Calls to /v2/agent_aliases/{key}/... target the alias. Calls to /v2/agents/{key}/... target the agent.

Example:support

The unique key of the alias to list connectors for.

Query parameters

type'slack' | 'gchat' | 'zoom' | 'widget'
Example:slack

Filter connectors by type.

enabledboolean
Example:true

Filter connectors by enabled status.

limitinteger

The maximum number of connectors to return in the list.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of available connectors for the alias.

Example response

{
  "connectors": [
    {
      "id": "con_support_9f3a1c2b4d5e6f708192a3b4c5d6e7f8",
      "alias_key": "support",
      "name": "Customer Support Slack Channel",
      "description": "Receives customer support messages from the",
      "type": "slack",
      "status": "active",
      "status_message": "Slack authentication successful",
      "metadata": {
        "priority": "high",
        "department": "customer_service"
      },
      "enabled": true,
      "configuration": {
        "hidden_output_types": [
          "tool_calls"
        ],
        "type": "slack",
        "bot_token": "xoxb-1234567890-1234567890123-abcdefghijklmnopqrstuvwx",
        "signing_secret": "abcdef1234567890abcdef1234567890abcdef12",
        "api_app_id": "A1234567890",
        "webhook_path": "/v2/agents/customer_support/connectors/con_3Kx9QpVn2mZr8YbLc5TdWe/input"
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-16T14:45:00Z",
      "last_webhook_at": "2024-01-16T14:45:00Z",
      "last_webhook_status": "success"
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}

Changes

Changed in 2 of the 13 revisions of this API.2

  • 5cd882cb3cda1See the full diff
    • ○

      added the optional property //////// to the response with the status

      response-optional-property-added

  • de6b34bc4a4f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog