APIClarity

APIClarity Notifications API

An inverted contract — the endpoint a registered listener must implement, which APIClarity POSTs to. Six notification types share one polymorphic envelope discriminated on notificationType: NewDiscoveredAPINotification, SpecDiffsNotification, ApiFindingsNotification, AuthorizationModelNotification, TestProgressNotification and TestReportNotification. This is APIClarity's webhook surface; no AsyncAPI document is published.

Documentation GitHub OpenAPI

Operations 1

POST /notification/{apiID} Provide to Apiclarity list of raw input for a given API ID associated with a given timestamp

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/apiclarity-notifications-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

components:
  schemas:
    APIClarityNotification:
      discriminator:
        mapping:
          ApiFindingsNotification: '#/components/schemas/ApiFindingsNotification'
          AuthorizationModelNotification: '#/components/schemas/AuthorizationModelNotification'
          NewDiscoveredAPINotification: '#/components/schemas/NewDiscoveredAPINotification'
          SpecDiffsNotification: '#/components/schemas/SpecDiffsNotification'
          TestProgressNotification: '#/components/schemas/TestProgressNotification'
          TestReportNotification: '#/components/schemas/TestReportNotification'
        propertyName: notificationType
      oneOf:
      - $ref: '#/components/schemas/ApiFindingsNotification'
      - $ref: '#/components/schemas/AuthorizationModelNotification'
      - $ref: '#/components/schemas/NewDiscoveredAPINotification'
      - $ref: '#/components/schemas/SpecDiffsNotification'
      - $ref: '#/components/schemas/TestProgressNotification'
      - $ref: '#/components/schemas/TestReportNotification'
    APIFindings:
      description: A group of findings
      properties:
        items:
          description: A list of findings
          items:
            $ref: ../common/openapi.yaml#/components/schemas/APIFinding
          type: array
      type: object
    ApiFindingsNotification:
      allOf:
      - $ref: '#/components/schemas/BaseNotification'
      - $ref: '#/components/schemas/APIFindings'
    ApiInfo:
      properties:
        destinationNamespace:
          type: string
        hasProvidedSpec:
          default: false
          type: boolean
        hasReconstructedSpec:
          default: false
          type: boolean
        id:
          format: uint32
          type: integer
        name:
          description: API name
          type: string
        port:
          type: integer
        traceSourceId:
          description: Trace Source ID which created this API. Null UUID 0 means it
            has been created by APIClarity (from the UI for example)
          format: uuid
          type: string
      type: object
    AuthorizationModel:
      properties:
        learning:
          type: boolean
        operations:
          items:
            $ref: ../global/openapi.gen.yaml#/components/schemas/AuthorizationModelOperation
          type: array
        specType:
          $ref: ../global/openapi.gen.yaml#/components/schemas/SpecType
      required:
      - specType
      - operations
      - learning
      type: object
    AuthorizationModelNotification:
      allOf:
      - $ref: '#/components/schemas/BaseNotification'
      - $ref: '#/components/schemas/AuthorizationModel'
    BaseNotification:
      description: Base Notification all APIClarity notifications must extend
      properties:
        notificationType:
          type: string
      required:
      - notificationType
      type: object
    NewDiscoveredAPINotification:
      allOf:
      - $ref: '#/components/schemas/BaseNotification'
      - $ref: '#/components/schemas/ApiInfo'
    ShortTestProgress:
      description: Describes the progress of an ongoing test
      properties:
        apiID:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
        progress:
          description: Progress of the test
          maximum: 100
          minimum: 0
          title: Description
          type: integer
        starttime:
          description: Timestamp of the start of the test
          format: int64
          title: Start time
          type: integer
      required:
      - starttime
      - progress
      title: Short Test Progress Report
      type: object
    ShortTestReport:
      description: Short Test Report
      properties:
        apiID:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
        highestSeverity:
          $ref: ../common/openapi.yaml#/components/schemas/Severity
        starttime:
          description: Timestamp of the start of the test
          format: int64
          title: Start time
          type: integer
        status:
          $ref: ../global/openapi.gen.yaml#/components/schemas/FuzzingStatusEnum
        statusMessage:
          description: Message for status details, if any
          title: Status message details
          type: string
        tags:
          items:
            $ref: ../global/openapi.gen.yaml#/components/schemas/FuzzingReportTag
          title: Tags list
          type: array
      required:
      - starttime
      - status
      title: Short Test Report
      type: object
    SpecDiffs:
      properties:
        diffs:
          $ref: ../global/openapi.gen.yaml#/components/schemas/APIDiffs
      required:
      - diffs
      type: object
    SpecDiffsNotification:
      allOf:
      - $ref: '#/components/schemas/BaseNotification'
      - $ref: '#/components/schemas/SpecDiffs'
    TestProgressNotification:
      allOf:
      - $ref: '#/components/schemas/BaseNotification'
      - $ref: '#/components/schemas/ShortTestProgress'
    TestReportNotification:
      allOf:
      - $ref: '#/components/schemas/BaseNotification'
      - $ref: '#/components/schemas/ShortTestReport'
info:
  title: Core OAPI for APIClarity Notification
  version: "1.0"
openapi: 3.0.2
paths:
  /notification/{apiID}:
    post:
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/APIClarityNotification'
        description: Notification
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                type: string
          description: Success
      summary: Provide to Apiclarity list of raw input for a given API ID associated
        with a given timestamp
servers:
- url: /

APIClarity Notifications API

Operations 1

Documentation

Specifications

SDKs

Other Resources