Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Highlight (highlight.io) Webhooks API

Inbound webhook delivery from Highlight

Highlight (highlight.io) Webhooks API is one of 8 APIs that Highlight (highlight.io) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against 2 base URLs: https://otel.highlight.io, http://localhost:4318.

1 operations 1 paths 1 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Servers
https://otel.highlight.io
http://localhost:4318
License
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.

Webhooks 1

Inbound webhook delivery from Highlight

POST
/
Receive Highlight Alert Webhook
receiveHighlightAlertWebhook body → 2002024XX5XX

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is AlertWebhookPayload (21 properties). Each schema is shown below with its type and property counts.

AlertWebhookPayload
object
Payload sent for alert webhook deliveries.
21 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlight-io-webhooks-api-openapi.yml Raw ↑

Other APIs Highlight (highlight.io) publishes across the network.

Highlight Private GraphQL API
Highlight Webhooks API
Highlight Self-Hosted Deployment
Highlight (highlight.io) Logs API
Highlight (highlight.io) Metrics API
Highlight (highlight.io) Sessions API
Highlight (highlight.io) Traces API