Coralogix Cases notification service API

openapi: 3.2.0
info:
  title: Coralogix Management Cases notification service API
  version: '5'
  description: 'Management API for the Coralogix observability platform. The base URL is region-specific: pick the `servers` entry matching your Coralogix domain. Authentication is a bearer API key.'
servers:
- url: https://api.eu1.coralogix.com/mgmt/openapi/5
- url: https://api.eu2.coralogix.com/mgmt/openapi/5
- url: https://api.us1.coralogix.com/mgmt/openapi/5
- url: https://api.us2.coralogix.com/mgmt/openapi/5
- url: https://api.us3.coralogix.com/mgmt/openapi/5
- url: https://api.ap1.coralogix.com/mgmt/openapi/5
- url: https://api.ap2.coralogix.com/mgmt/openapi/5
- url: https://api.ap3.coralogix.com/mgmt/openapi/5
- url: https://api.gov1.coralogixgov.us/mgmt/openapi/5
security:
- apiKeyAuth: []
tags:
- name: Cases notification service
  description: Track notification adjacent data for cases.
paths:
  /cases/notifications/v1/deliveries:
    post:
      description: 'Retrieve notification delivery records for one or more cases, including routing, target, and outcome information.


        Requires the following permissions:

        - `case:Read`'
      operationId: CasesNotificationService_ListNotificationDeliveries
      requestBody:
        content:
          application/json:
            schema:
              description: Request to retrieve notification delivery records for one or more cases.
              properties:
                caseIds:
                  description: Case IDs to retrieve notification deliveries for
                  examples:
                  - - 3f166e9f-3c88-4af2-b52e-138f339dab3e
                    - a1b2c3d4-e5f6-7890-abcd-ef1234567890
                  items:
                    description: Case IDs to retrieve notification deliveries for
                    maxLength: 64
                    minLength: 1
                    pattern: ^[\s\S]*$
                    type: string
                  maxItems: 1000
                  minItems: 1
                  type: array
              required:
              - caseIds
              title: List notification deliveries request
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNotificationDeliveriesResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      summary: List notification deliveries for cases
      tags:
      - Cases notification service
      x-coralogixPermissions:
      - case:Read
components:
  schemas:
    DeliveryFailure:
      title: Delivery failure
      required:
      - errorMessage
      type: object
      properties:
        errorMessage:
          maxLength: 4096
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: Error message describing the failure
          examples:
          - Connection timeout after 30s
      description: Failed delivery outcome with error details.
    DeliveryOutcome:
      title: Delivery outcome
      type: object
      oneOf:
      - required:
        - success
        type: object
      - required:
        - failure
        type: object
      - type: object
        not:
          anyOf:
          - required:
            - success
            type: object
          - required:
            - failure
            type: object
      properties:
        failure:
          allOf:
          - $ref: '#/components/schemas/DeliveryFailure'
          description: Delivery failed
        success:
          allOf:
          - $ref: '#/components/schemas/DeliverySuccess'
          description: Delivery succeeded
      description: Outcome of a notification delivery attempt.
    v1.ConnectorType:
      enum:
      - CONNECTOR_TYPE_UNSPECIFIED
      - CONNECTOR_TYPE_SLACK
      - CONNECTOR_TYPE_SERVICE_NOW
      - CONNECTOR_TYPE_PAGER_DUTY
      - CONNECTOR_TYPE_EMAIL
      - CONNECTOR_TYPE_GENERIC_HTTPS
      - CONNECTOR_TYPE_MICROSOFT_TEAMS
      type: string
      description: Connector type.
    Error:
      type: object
      properties:
        code:
          maximum: 599
          minimum: 100
          type: integer
          description: HTTP status code of the error (for example 400, 404, 500).
          format: int32
        message:
          maxLength: 4096
          minLength: 0
          pattern: ^[\s\S]*$
          type: string
          description: Human-readable description of the error.
      description: Standard error response body returned for a failed request.
    CaseNotificationDeliveries:
      title: Case notification deliveries
      required:
      - notificationDeliveries
      type: object
      properties:
        notificationDeliveries:
          maxItems: 1000
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/NotificationDelivery'
          description: Notification deliveries for the case
      description: Notification deliveries for a single case.
    ConnectorDetails:
      title: Connector details
      required:
      - connectorId
      - connectorType
      - connectorName
      type: object
      properties:
        connectorId:
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
          type: string
          description: Unique identifier of the connector
          examples:
          - c1d2e3f4-5678-90ab-cdef-1234567890ab
        connectorName:
          maxLength: 256
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: Display name of the connector
          examples:
          - Production Slack
        connectorType:
          allOf:
          - $ref: '#/components/schemas/v1.ConnectorType'
          description: Type of the connector
      description: Details of a notification connector.
    DeliverySuccess:
      title: Delivery success
      type: object
      properties:
        evidenceUrl:
          description: URL to the delivered notification, if available (e.g. Slack message, ServiceNow record)
          examples:
          - https://workspace.slack.com/archives/C01ABC23DEF/p1234567890123456
          maxLength: 2048
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          x-coralogix-presence: true
      description: Successful delivery outcome with an optional evidence URL.
    RouterInfo:
      title: Router info
      required:
      - routerId
      - routerName
      type: object
      properties:
        routerId:
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
          type: string
          description: Unique identifier of the router
          examples:
          - d4e5f678-90ab-cdef-1234-567890abcdef
        routerName:
          maxLength: 256
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: Display name of the router
          examples:
          - Production alerts router
      description: Information about a notification router.
    NoRouterMatchedResult:
      title: No router matched result
      type: object
      additionalProperties: false
      description: Indicates that no router matched the notification request.
    NoNotificationCreatedResult:
      title: No notification created result
      required:
      - matchedRouters
      type: object
      properties:
        matchedRouters:
          maxItems: 1000
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/RouterInfo'
          description: Routers that matched the notification request
      description: Indicates that routers matched but no notification was ultimately created.
    DeliveryAttempt:
      title: Delivery attempt
      required:
      - connector
      - outcome
      type: object
      properties:
        connector:
          allOf:
          - $ref: '#/components/schemas/ConnectorDetails'
          description: The connector that the delivery was sent to
        outcome:
          allOf:
          - $ref: '#/components/schemas/DeliveryOutcome'
          description: Outcome of the delivery attempt
      description: A single delivery attempt to a specific connector.
    NotificationDelivery:
      title: Notification delivery
      required:
      - timestamp
      type: object
      oneOf:
      - required:
        - noRouterMatched
        type: object
      - required:
        - noNotificationCreated
        type: object
      - required:
        - attempted
        type: object
      - type: object
        not:
          anyOf:
          - required:
            - noRouterMatched
            type: object
          - required:
            - noNotificationCreated
            type: object
          - required:
            - attempted
            type: object
      properties:
        attempted:
          allOf:
          - $ref: '#/components/schemas/RoutedDelivery'
          description: Delivery was attempted through a router to one or more connectors
        noNotificationCreated:
          allOf:
          - $ref: '#/components/schemas/NoNotificationCreatedResult'
          description: Routers matched but no notification was created
        noRouterMatched:
          allOf:
          - $ref: '#/components/schemas/NoRouterMatchedResult'
          description: No router matched the notification request
        requestNotificationId:
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          description: The notification request ID that triggered this delivery, used to correlate delivery outcomes with their originating requests
          examples:
          - a1b2c3d4-5678-90ab-cdef-1234567890ab
        timestamp:
          description: When the notification was triggered
          examples:
          - '2025-09-22T10:30:00.000Z'
          format: date-time
          maxLength: 30
          minLength: 20
          type: string
          x-coralogix-presence: true
      description: Delivery results for a single notification.
    ListNotificationDeliveriesResponse:
      title: List notification deliveries response
      required:
      - deliveriesByCase
      type: object
      properties:
        deliveriesByCase:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CaseNotificationDeliveries'
          description: Notification deliveries keyed by case ID
      description: Response containing a list of notification delivery records for cases.
    RoutedDelivery:
      title: Routed delivery
      required:
      - router
      - attempts
      type: object
      properties:
        attempts:
          maxItems: 100
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/DeliveryAttempt'
          description: Individual delivery attempts to connectors
        router:
          allOf:
          - $ref: '#/components/schemas/RouterInfo'
          description: The router that handled the notification
      description: Delivery attempts routed through a single router to one or more connectors.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication
externalDocs:
  description: Coralogix API reference
  url: https://coralogix.com/docs/api-reference/v5/
x-provenance:
  method: harvested
  publisher: Coralogix
  source: https://coralogix.com/docs/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)