Skip to content
Vessios Docs
English
English日本語
Esc
↑↓navigate↵open⌘Jpreview
On this page

Integrations

API keys, webhooks, and connectors for automating and extending Vessios.

API keys

For server-to-server access, create an API key instead of using your session token:

  • POST /api-keys — create a key. Keys are scoped to viewer or editor permissions (not admin/owner), so an API key can never be used to escalate privileges beyond content access.
  • GET /api-keys — list your keys.
  • DELETE /api-keys/{key_id} — revoke a key.

Send the key in the X-Api-Key header on each request. Keys are stored as a SHA-256 hash — Vessios never stores or displays the raw key after creation, so keep it somewhere safe when you create it.

Webhooks

Register a webhook to be notified when events happen in your tenant:

  • POST /webhooks — register a webhook URL.
  • GET /webhooks — list registered webhooks.
  • GET /webhooks/sample — see a sample payload before you integrate.
  • DELETE /webhooks/{webhook_id} — remove a webhook.

Currently supported event: ingest.completed, fired when an ingest run finishes. Every delivery is signed with HMAC-SHA256 so you can verify it came from Vessios, and every webhook URL is validated against SSRF protections at registration and send time.

Slack

Vessios can post notifications to Slack and answer questions asked directly in Slack, backed by the same query pipeline as the web UI. Configure and test your Slack integration via POST /settings/slack/test.

Connectors

Vessios can pull content from external knowledge tools on a schedule an admin controls:

  • Notion — connect and sync pages via POST /admin/connectors/notion/token and POST /admin/connectors/notion/sync. Each synced Notion page becomes one ingest.
  • Confluence — connect and sync via POST /admin/connectors/confluence/token and POST /admin/connectors/confluence/sync.

Connector sync is currently admin-triggered rather than fully automatic; both connectors validate their target host to prevent requests from being redirected elsewhere.

Export

You can export your entire wiki for use in other tools:

  • POST /export — export as llms.txt, llms-full.txt (llmstxt.org-compliant, for feeding your wiki into downstream LLM workflows), or graphml (for graph visualization tools).

Was this page helpful?