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 Org Level Webhooks API

The Org Level Webhooks API from Ocrolus — 8 operation(s) for org level webhooks.

Ocrolus Org Level 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 Org Level Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 8 operations across 8 paths, and defines 21 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.

8 operations 8 paths 21 schemas 1 DELETE3 GET4 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 Org Level 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 8

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

Org Level Webhooks 8
POST
/webhook
Add webhook
add-webhook body → 200400
POST
/webhook/{webhook_uuid}/rotate-secret
Configure webhook secret
configure-webhook-secret-org-level 1 param body → 200404
DELETE
/webhook/{webhook_uuid}/delete
Delete webhook
delete-webhook 1 param → 200400
GET
/webhooks
List webhooks
list-webhooks → 200
GET
/webhook/{webhook_uuid}/events
List webhook events
list-events 1 param → 200400
GET
/webhook/{webhook_uuid}
Retrieve webhook
get-webhook 1 param → 200400
POST
/webhook/{webhook_uuid}/test
Test webhook
test-org-webhook 1 param body → 200
POST
/webhook/{webhook_uuid}/update
Update webhook
update-webhook 1 param body → 200400

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Event (7 properties), Webhook (6 properties), ErrorStructure (4 properties), SuccessStructure (2 properties). Each schema is shown below with its type and property counts.

Webhook
object
6 properties
inline_response_200_1
inline_response_400_4
ErrorStructure
object
4 properties
Event
object
7 properties
inline_response_200_5_response
object
1 property
inline_response_400_3
inline_response_400_3_meta
object
1 property
inline_response_200_5
inline_response_200_4
webhook_body
object
2 properties
ErrorStructure_meta
object
2 properties
inline_response_200_4_response
object
1 property
inline_response_400_4_meta
object
1 property
webhook_uuid_update_body
object
2 properties
inline_response_200_3
inline_response_400_5
SuccessStructure
object
2 properties
inline_response_400_5_meta
object
1 property
inline_response_200_6
inline_response_200_1_response
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ocrolus-org-level-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 Org Level 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.