> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oasm.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a new integration

> Connects a third-party application to the specified workspace. Config is validated against the JSON Schema for the given appType + category.



## OpenAPI

````yaml /api-reference/openapi.json post /api/integrations
openapi: 3.0.0
info:
  title: Open Attack Surface Management
  description: Open-source platform for cybersecurity Attack Surface Management (ASM)
  version: '1.0'
  contact: {}
servers:
  - url: https://{baseUrl}/api/v1
    variables:
      baseUrl:
        default: localhost:3000
        description: API server hostname with port (e.g. localhost:3000, api.example.com)
security: []
tags: []
externalDocs:
  description: Authentication Docs
  url: auth/docs
paths:
  /api/integrations:
    post:
      tags:
        - Integrations
      summary: Create a new integration
      description: >-
        Connects a third-party application to the specified workspace. Config is
        validated against the JSON Schema for the given appType + category.
      operationId: IntegrationsController_createIntegration
      parameters:
        - name: X-Workspace-Id
          in: header
          description: Workspace ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIntegrationDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntegrationDto'
                allOf:
                  - $ref: '#/components/schemas/AppResponseSerialization'
components:
  schemas:
    CreateIntegrationDto:
      type: object
      properties:
        name:
          type: string
          example: My Jira Integration
          description: Human-readable name
        description:
          type: string
          description: Optional description
        appType:
          type: string
          example: jira
          description: Third-party app identifier
        category:
          type: string
          example: ticketing
          description: Integration category
        config:
          type: object
          description: App-specific configuration validated via JSON Schema
          example:
            host: https://your-domain.atlassian.net
            email: user@example.com
            apiToken: your-api-token
      required:
        - name
        - appType
        - category
        - config
    GetIntegrationDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        appType:
          type: string
        category:
          type: string
        config:
          type: object
          description: Configuration with sensitive fields masked
        workspaceId:
          type: string
        createdById:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - name
        - appType
        - category
        - config
        - workspaceId
        - createdById
        - createdAt
        - updatedAt

````