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

Ocrolus Webhooks API

The Webhooks API from Ocrolus — 4 operation(s) for webhooks.

Ocrolus Webhooks API is one of 16 APIs that Ocrolus 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, authentication docs, and rate-limit docs.

This API exposes 4 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

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

4 operations 4 paths 3 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.ocrolus.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Ocrolus Webhooks API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth) using the clientCredentials flow. By default, every request must be authenticated.

  • oauth — OAuth 2.0 support via client credentials flow. See [here](doc:using-api-credentials) for usage information.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 4
POST
/v1/account/settings/update/webhook_endpoint
Configure webhook
configure-webhook body → 200400
GET
/v1/account/settings/webhook_details
Get webhook configuration
webhook-configuration → 200
GET
/v1/account/settings/test_webhook_endpoint
Test webhook
test-webhook → 200
POST
/v1/account/settings/webhook/rotate-secret
Configure webhook secret
configure-webhook-secret-account-level body → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are JsonResponse (3 properties), WebhookRegistration (2 properties). Each schema is shown below with its type and property counts.

WebhookEventType
string
The type of event that Ocrolus broadcasts.
JsonResponse
object
3 properties 3 required
WebhookRegistration
object
An object that describes the active webhook registration. Only one webhook can be registered at this time; if you need multiple event handlers, your implementa…
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ocrolus-webhooks-api-openapi.yml Raw ↑

Other APIs Ocrolus publishes across the network.

Ocrolus Book Commands API
Ocrolus Book Queries API
Ocrolus Business history API
Ocrolus Business Verification (Deprecated) API
Ocrolus Capture API
Ocrolus Cash Flow Analytics API
Ocrolus Detect API
Ocrolus Encore API
Ocrolus File Uploads API
Ocrolus Income API
Ocrolus Legacy Cash Flow Analytics (Deprecated) API
Ocrolus Oauth API
Where this information came from

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