How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

APIClarity Notifications API is one of 11 APIs that APIClarity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhooks, Notifications, and Events. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 1 operation across 1 path, and defines 14 schemas. It is described by OpenAPI 3.0.2, at version 1.0.

Requests are made against a single base URL, /.

1 operations 1 paths 14 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0
Server
/
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 1
POST
/notification/{apiID}
Provide to Apiclarity list of raw input for a given API ID associated with a given timestamp
1 param body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ApiInfo (7 properties), ShortTestReport (6 properties), AuthorizationModel (3 properties), ShortTestProgress (3 properties). Each schema is shown below with its type and property counts.

APIClarityNotification
APIFindings
object
A group of findings
1 property
ApiFindingsNotification
ApiInfo
object
7 properties
AuthorizationModel
object
3 properties 3 required
AuthorizationModelNotification
BaseNotification
object
Base Notification all APIClarity notifications must extend
1 property 1 required
NewDiscoveredAPINotification
ShortTestProgress
object
Describes the progress of an ongoing test
3 properties 2 required
ShortTestReport
object
Short Test Report
6 properties 2 required
SpecDiffs
object
1 property 1 required
SpecDiffsNotification
TestProgressNotification
TestReportNotification

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiclarity-notifications-openapi.yml Raw ↑

Other APIs APIClarity publishes across the network.

APIClarity API Events API
APIClarity API Inventory API
APIClarity Control API
APIClarity Features API
APIClarity BFLA Module API
APIClarity Fuzzer Module API
APIClarity Trace Analyzer Module API
APIClarity Spec Differ Module API
APIClarity Spec Reconstructor Module API
APIClarity Plugins Telemetry API
Where this information came from

This is an independent, third-party profile of APIClarity Notifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.