Skip to main content

​
List Integrations

List all integrations for an instance with pagination, filtering, and sorting. Endpoint: GET /instances/:instanceId/integrations Query Parameters:
  • type (string, optional) - Filter by integration type
  • status (string, optional) - Filter by status
  • search (string, optional) - Search by name/description
  • page (number, optional) - Page number (0-based)
  • size (number, optional) - Page size
  • sort (string, optional) - Sort field and direction
Response: Paginated response with integration list Source: Feature Inventory - API Surface (Integrations API)

​
Get Integration

Get a single integration by ID. Endpoint: GET /instances/:instanceId/integrations/:integrationId Response: Integration object Source: Feature Inventory - API Surface (Integrations API)

​
Create Integration

Create a new integration. Endpoint: POST /instances/:instanceId/integrations Request Body: 
{
  "name": "Integration Name",
  "type": "AMAZON_CONNECT",
  "metadata": {
    "instanceId": "...",
    "accessKeyId": "...",
    "secretAccessKey": "...",
    "region": "us-east-1"
  }
}
Fields:
  • name (string, required) - Integration name
  • type (string, required) - Integration type (see Integration Types)
  • metadata (object, required) - Integration-specific configuration
Response: Created integration object Source: Feature Inventory - API Surface (Integrations API)

​
Update Integration

Update an existing integration. Endpoint: PUT /instances/:instanceId/integrations/:integrationId Request Body: Same as Create Integration Response: Updated integration object Source: Feature Inventory - API Surface (Integrations API)

​
Delete Integration

Delete an integration. Endpoint: DELETE /instances/:instanceId/integrations/:integrationId Response: 204 No Content Source: Feature Inventory - API Surface (Integrations API)

​
Test Connection

Test an integration connection. Endpoint: POST /instances/:instanceId/integrations/:integrationId/test Response: 
{
  "success": true,
  "message": "Connection successful",
  "timestamp": "2024-12-26T..."
}
Source: Feature Inventory - API Surface (Integrations API)