openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva Alert Workflows API
  description: 'The Corva API is a powerful interface providing great flexibility and extensibility with Corva. Whether your needs are simple UI visualizations, data entry, replication/sync tasks, real-time stream processing, or complex machine learning CPU-intensive apps, the Corva API is the way to make it happen. Our concepts are split into three distinct silos: data apps, visualization apps, and a REST API'
  termsOfService: https://www.corva.ai/terms-and-conditions/
  contact:
    name: Corva API Team
    email: support@corva.ai
security:
- api_key: []
tags:
- name: Alert Workflows
  description: Alert status workflow definitions (global and company-specific)
paths:
  /v1/alert_workflows:
    get:
      summary: List Alert Workflows
      tags:
      - Alert Workflows
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: array
          description: Returns global workflows and workflows belonging to the current company, optionally filtered by company_id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertWorkflowList'
      parameters:
      - in: query
        name: company_id
        description: Filter by company ID (must be nil/current company or a company accessible to the user)
        required: false
        schema:
          type: integer
          format: int64
      operationId: getV1AlertWorkflows
      x-operation-id-source: derived
  /v1/alert_workflows/{id}:
    get:
      summary: Get Alert Workflow
      tags:
      - Alert Workflows
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Workflow not found or not accessible by current company
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertWorkflow'
      parameters:
      - in: path
        name: id
        description: AlertWorkflow ID
        required: true
        schema:
          type: integer
          format: int64
      operationId: getV1AlertWorkflowsById
      x-operation-id-source: derived
  /v2/alert_workflows:
    get:
      summary: List Alert Workflows
      tags:
      - Alert Workflows
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: Returns global workflows and workflows belonging to the current company, optionally filtered by company_id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertWorkflowV2List'
      parameters:
      - in: query
        name: company_id
        description: Filter by company ID (must be nil/current company or a company accessible to the user)
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: page
        description: Page number
        required: false
        schema:
          type: integer
      - in: query
        name: per_page
        description: Items per page
        required: false
        schema:
          type: integer
      operationId: getV2AlertWorkflows
      x-operation-id-source: derived
  /v2/alert_workflows/{id}:
    get:
      summary: Get Alert Workflow
      tags:
      - Alert Workflows
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Workflow not found or not accessible by current company
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertWorkflowV2Single'
      parameters:
      - in: path
        name: id
        description: AlertWorkflow ID
        required: true
        schema:
          type: integer
          format: int64
      operationId: getV2AlertWorkflowsById
      x-operation-id-source: derived
components:
  schemas:
    AuthorizationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 403
        message: Access denied
    AlertWorkflowV2List:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AlertWorkflowV2'
    AlertWorkflowList:
      type: array
      items:
        $ref: '#/components/schemas/AlertWorkflow'
    AlertWorkflowV2Single:
      properties:
        data:
          type: object
          $ref: '#/components/schemas/AlertWorkflowV2'
    AuthenticationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 401
        message: Missing authentication. Please try again.
    AlertWorkflowV2:
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
          required:
          - id
          - name
          - flow
          properties:
            id:
              type: integer
              format: int64
            name:
              type: string
            flow:
              type: object
              description: State machine definition. Keys are status names; each value has a "transitions" array.
              properties:
                status_name:
                  type: object
                  properties:
                    transitions:
                      type: array
                      items:
                        type: object
                        properties:
                          status:
                            type: string
                            description: Target status
                          interaction:
                            type: string
                            description: e.g. "immediate"
                          hidden:
                            type: boolean
                            description: Whether this transition is hidden from the UI
            default:
              type: boolean
              description: True for the global default workflow
            company_id:
              type: integer
              format: int64
              description: Null for global workflows
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
    AlertWorkflow:
      required:
      - id
      - name
      - flow
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        flow:
          type: object
          description: State machine definition. Keys are status names; each value has a "transitions" array.
          properties:
            status_name:
              type: object
              properties:
                transitions:
                  type: array
                  items:
                    type: object
                    properties:
                      status:
                        type: string
                        description: Target status
                      interaction:
                        type: string
                        description: e.g. "immediate"
                      hidden:
                        type: boolean
                        description: Whether this transition is hidden from the UI
        default:
          type: boolean
          description: True for the global default workflow
        company_id:
          type: integer
          format: int64
          description: Null for global workflows
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      example:
        id: 1
        name: V1 Workflow
        flow:
          open:
            transitions:
            - status: acknowledged
              interaction: immediate
            - status: closed
              interaction: immediate
            - status: invalid
              interaction: immediate
              hidden: true
          acknowledged:
            transitions:
            - status: closed
              interaction: immediate
            - status: invalid
              interaction: immediate
              hidden: true
          closed:
            transitions: []
          invalid:
            transitions: []
        default: true
        company_id: null
        created_at: '2026-04-09T12:00:00Z'
        updated_at: '2026-04-09T12:00:00Z'
    NotFoundError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 404
        message: Not found
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header