Website connector
Create a website connector
POST /knowledgeSource/websiteConnector
POST /knowledgeSource/websiteConnector
Creates a new website connector with the given URL and configuration. Generates a webhook secret automatically.
Request body
urlstringbodyrequiredThe URL to crawl
namestringbodyDisplay name for the connector. Defaults to the hostname of the URL.
parentintegerbodyParent folder ID in knowledge source structure
maxPagesintegerbodyDefault: 100Maximum number of pages to crawl
frequencyenumbodyDefault: weeklyCrawl frequency Options: daily, weekly
descriptionstringbodyDescription of the connector
includePathsstring[]bodyURL path patterns to include
excludePathsstring[]bodyURL path patterns to exclude
Request Example
{
"url": "https://example.com",
"name": "Example Website",
"parent": 0,
"maxPages": 50,
"frequency": "weekly",
"description": "string",
"includePaths": [
"string"
],
"excludePaths": [
"string"
]
}Responses
200 — Created
Response Example
{
"success": true,
"id": 42
}422 — Validation error (missing URL or unconfigured webhook URL)
500 — Internal error