---
title: "Other reference types"
url: "/help/buuk/other-reference-types"
updated: "2026-10-22T11:13:54.259Z"
---
# Other reference types

The reference parser reads spec structure, not only OpenAPI documents. Whatever the file declares — REST paths, event channels, or RPC methods — it becomes operation pages in the same API Reference collection, grouped by tag and searchable like everything else.

## Webhooks in OpenAPI

A spec can document events your API sends to its consumers. Under OpenAPI 3.1 the `webhooks` key holds those definitions; some 3.0 specs use the `x-webhooks` convention. Each event becomes a `WEBHOOK` operation with the payload schema it describes, listed next to the path operations instead of hidden in prose.

## AsyncAPI

A file whose top-level key is `asyncapi` is read the same way. AsyncAPI 2 specs contribute one operation per channel: `PUBLISH` where your system emits, `SUBSCRIBE` where it consumes, with the message payload shown as the body or response schema and channel parameters listed alongside. AsyncAPI 3 files are supported on a best-effort basis through their `operations` entries.

## OpenRPC

A JSON-RPC API documented with `openrpc` renders too: each method becomes a `CALL` operation — its parameters read as a request body and its result as the response schema.

## What non-HTTP pages include

Webhook, publish, subscribe, and call operations show the full schema detail: parameters, payload structures, and response examples. They do not carry the Try It panel or per-language code samples, which exist only where a real HTTP request can be built from the browser — there is no URL to send for an inbound message channel.

Anything else — a file missing one of those top-level keys, or malformed YAML or JSON — is refused at import, so a bad spec never half-renders into the public reference. Check the top-level key, fix the syntax, and retry.

> [!NOTE]
> The upload box accepts YAML or JSON, and GitHub sync recognizes file names such as `asyncapi.yaml` and `openrpc.json`. Multiple spec files in one repository each get their own reference.

## Related

- Import behavior and versions: [Import an OpenAPI spec](./import-openapi).
- The HTTP-only pieces these pages leave out: [The Try It playground](./try-it-playground).
- Exports that depend on operations: [Code samples and SDKs](./code-samples-and-sdks).
- Where a prose walkthrough belongs: [Documentation vs FAQ vs Guides vs API](./docs-collections).