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

Scalar Webhooks API

Register endpoints for platform events, and inspect what was delivered to them.

Scalar Webhooks API is one of 39 APIs that Scalar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 6 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against a single base URL, https://api.scalar.com/core.

7 operations 6 paths 14 schemas 1 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Server
https://api.scalar.com/core
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Scalar Webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 7

Register endpoints for platform events, and inspect what was delivered to them.

POST
/v1/webhooks
Post V1 webhooks
postV1Webhooks body → 200400401403404422500
PATCH
/v1/webhooks/{uid}
Patch V1 webhooks uid
patchV1WebhooksUid 1 param body → 200400401403404422500
DELETE
/v1/webhooks/{uid}
Delete V1 webhooks uid
deleteV1WebhooksUid 1 param → 200400401403404422500
POST
/v1/webhooks/{uid}/secret
Post V1 webhooks uid secret
postV1WebhooksUidSecret 1 param body → 200400401403404422500
GET
/v1/webhooks/delivery-counts
Get V1 webhooks delivery counts
getV1WebhooksDeliveryCounts → 200400401403404422500
GET
/v1/webhooks/{uid}/deliveries
Get V1 webhooks uid deliveries
getV1WebhooksUidDeliveries 1 param → 200400401403404422500
POST
/v1/webhooks/{uid}/test
Post V1 webhooks uid test
postV1WebhooksUidTest 1 param → 200400401403404422500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are sdk-build-completed-event (3 properties), 500 (2 properties), 400 (2 properties), 401 (2 properties). Each schema is shown below with its type and property counts.

sdk-build-outcome
string
nanoid
string
404
object
2 properties 2 required
timestamp
integer
webhook-disabled-reason
string
403
object
2 properties 2 required
sdk-build-status
string
422
object
2 properties 2 required
401
object
2 properties 2 required
webhook-delivery-status
string
webhook-event
string
400
object
2 properties 2 required
500
object
2 properties 2 required
sdk-build-completed-event
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scalar-webhooks-api-openapi.yml Raw ↑

Other APIs Scalar publishes across the network.

Scalar API References
Scalar API Client
Scalar Docs
Scalar Registry
Scalar SDKs
Scalar CLI
Scalar Access Groups API
Scalar Analytics API
Scalar API Docs API
Scalar Auth API
Scalar Docs API
Scalar Docs Projects API
Where this information came from

This is an independent, third-party profile of Scalar Webhooks 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.