Endpoints
Integrations
API reference for managing third-party integrations and connections.
Overview
The Integrations API manages connections to third-party services. Docimal supports multiple integration types (Slack, Teams, Discord, Zapier, Make, Webhook, CRM, Email, Calendar, Custom) with various authentication methods (OAuth2, API Key, Bearer Token, Basic Auth, Webhook Secret).
List Available Integrations
GET /integrations — Retrieve all available integration types. Each integration includes: name, slug, type, status, authentication method, capabilities, icon URL, and documentation URL. Filter by type or status.
Manage Connections
POST /connections — Create a new connection to an integration. GET /connections — List all connections in a workspace. PATCH /connections/{id} — Update connection configuration. DELETE /connections/{id} — Remove a connection. POST /connections/{id}/test — Test connectivity and verify credentials are valid.
OAuth Flow
POST /oauth/initiate — Start an OAuth2 authorization flow. Returns an authorization URL to redirect the user to. The callback URL handles the provider redirect and stores encrypted credentials. POST /oauth/refresh/{id} — Refresh an expired OAuth token for a connection.
Execute API Calls
POST /connections/{id}/execute — Execute an API call through a connection. The request is proxied through Docimal with built-in circuit breaker and rate limiting protection. Body: { method: string, url: string, headers?: object, body?: object, timeout?: number }. Returns the upstream response.
Workspace Integration Configs
GET /workspace-configs — List workspace-scoped OAuth configurations (credentials are sanitized). PUT /workspace-configs/integration/{integrationId} — Upsert OAuth credentials for a specific integration within the workspace. DELETE /workspace-configs/integration/{integrationId} — Remove workspace-level integration configuration.