Technical Integration

API authentication, platform webhooks, calendar OAuth, and knowledge base API for your IT team.

Non-technical? Start with the Quick Start guide — no API calls or technical setup required.

Prerequisites

Instance URL — your dedicated endpoint at https://{slug}.voxenova.com
API Key — a sk_... key from your welcome email

Both are provided in the welcome email after registration. If you've lost your API key, contact support for a replacement.

API Authentication

All API requests require an Authorization header:

      HTTP Header
      Authorization: Bearer sk_your_api_key_here
    

Verify your instance is running with the health endpoint:

      bash
      curl -s https://{slug}.voxenova.com/health | python3 -m json.tool
    

      json
      {
  "status": "healthy",
  "version": "4.0.0",
  "database": "connected",
  "redis": "connected"
}
    

For full setup details, see the Getting Started guide.

Scheduling API

Create, list, and cancel meetings programmatically.

Create a Meeting

      bash
      curl -X POST https://{slug}.voxenova.com/api/v1/schedule \
  -H "Authorization: Bearer sk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "meeting_url": "https://zoom.us/j/123456789",
    "meeting_type": "product_discovery",
    "scheduled_at": "2026-03-15T14:00:00Z",
    "duration_minutes": 60
  }'
    

Required Fields

Field	Type	Description
`meeting_url`	string	Zoom, Teams, or Google Meet link
`meeting_type`	string	One of: `product_discovery`, `sprint_inception`, `architecture_review`, `process_mapping`, `executive_assistant`
`scheduled_at`	ISO 8601	UTC start time
`duration_minutes`	integer	Expected duration (max depends on plan)

Status Lifecycle

Meetings progress: pending → launching → active → completed (or failed).

For listing, cancellation, and chat-based scheduling, see the Scheduling API guide.

Calendar OAuth

Connect Google or Microsoft calendars for automatic meeting detection.

Provider	Setup Summary
Google Calendar	Enable Chat API in Google Cloud Console, create OAuth credentials, connect in VoxeNova dashboard
Microsoft Outlook	Register an app in Azure AD, grant calendar read permissions, connect in VoxeNova dashboard

Auto-Join Modes

Mode	Behaviour
`all`	Join every meeting with a valid URL
`filtered`	Join only meetings matching your filter rules
`manual`	Never auto-join — schedule each meeting explicitly

For filter rules, email invite flow, and platform-specific setup, see the Calendar Integration guide.

Chat Platform Integrations

Connect your team's chat platform so users can schedule meetings and receive reports without leaving their workflow.

Platform	Auth Method	Setup Summary
Slack	Webhook + Bot Token	Install app from Marketplace, paste webhook URL
Microsoft Teams	Webhook URL	Create incoming webhook in channel
Google Chat	JWT Service Account	Enable Chat API, share service account JSON
Discord	Bot Token + Ed25519	Create Discord app, add bot to server
Mattermost	Bot Token	Create bot account, configure webhook
Zoom Chat	OAuth 2.0 (S2S)	Create Server-to-Server OAuth app
Webex	HMAC-SHA1	Register bot, configure webhook with HMAC secret
WhatsApp	Meta Cloud API	Set up WhatsApp Business account

For step-by-step setup for each platform, see the Integrations guide.

Knowledge Base API

Upload documents so the AI facilitator has context during meetings. Content is organised in a hierarchy:

Initiatives — top-level strategic themes
Projects — workstreams under an initiative
Documents — files attached to a project (PDF, DOCX, XLSX, images up to 50 MB)

Key Endpoints

Action	Method	Endpoint
Create initiative	`POST`	`/api/v1/initiatives`
Create project	`POST`	`/api/v1/projects`
Upload document	`POST`	`/api/v1/documents/upload`
Search documents	`POST`	`/api/v1/projects/{id}/search`

When you schedule a meeting linked to a project, the AI uses uploaded documents for pre-meeting briefing, entity extraction, and real-time retrieval during the call.

For full API examples and document processing details, see the Knowledge Base guide.

Reference

Meeting Types — five meeting types with API enum values and output artefacts
Billing & Plans — plans overview, usage tracking API, and payment management