Integrations API

List integrations

GET /api/integrations

Returns all configured integrations for your organization.

Response 200 OK

[
  {
    "id": "int_001",
    "type": "slack",
    "name": "#security-alerts",
    "enabled": true,
    "createdAt": "2025-01-20T14:00:00Z"
  }
]

Create or update integration

PUT /api/integrations

Creates a new integration or updates an existing one.

Request body

FieldTypeRequiredDescription
typestringYes"slack"
configobjectYesIntegration-specific configuration
enabledbooleanNoEnable or disable (default true)

Slack config

{
  "type": "slack",
  "config": {
    "webhookUrl": "https://hooks.slack.com/services/T.../B.../xxx"
  }
}

Response 200 OK

Test integration

POST /api/integrations/:id/test

Sends a test message through the integration to verify connectivity.

Response 200 OK

{
  "success": true,
  "message": "Test notification sent successfully"
}

On this page