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

Orum Configure webhooks API

The Configure webhooks API from Orum — 2 operation(s) for configure webhooks.

Orum Configure webhooks API is one of 17 APIs that Orum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version v2022-09-21.

Requests are made against 2 base URLs: https://api-sandbox.orum.io, https://vault.api-sandbox.orum.io.

4 operations 2 paths 9 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2022-09-21
Base URL
https://api.orum.io
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Orum Configure webhooks API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 29 scopes.

Paths & Operations 4

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

Configure webhooks 4
POST
/webhooks/configurations
Create webhook configuration
post-webhook-configuration 1 param body → 200401
GET
/webhooks/configurations
Retrieve list of webhook configurations
get-webhook-configurations 1 param → 200401
PUT
/webhooks/configurations/{id}
Update webhook configuration
put-webhook-configurations 2 params body → 200401
DELETE
/webhooks/configurations/{id}
Delete webhook configuration
delete-webhook-configurations 2 params → 204401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are WebhookConfiguration (10 properties), ConfigurationRequest (3 properties), ErrorResponse (3 properties), ConfigurationResponse (1 property). Each schema is shown below with its type and property counts.

DataVersion
string
dataversion is set by the Orum-Version used to create or update the webhook configuration. A webhook configuration with dataversion v2022-09-21 will match the…
ConfigurationResponse
object
1 property 1 required
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
ConfigurationRequest
object
3 properties 3 required
ConfigurationsResponse
object
1 property 1 required
EventTypes
array
The types of events for which you would like to receive a webhook e.g. transfercreated. Use subscribeall to receive webhooks for all events.
WebhookConfiguration
object
10 properties 10 required
ErrorResponse
object
3 properties 2 required
EventType
string
The type of event you want to invoke a webhook for.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-configure-webhooks-api-openapi.yml Raw ↑

Other APIs Orum publishes across the network.

Orum Authentication API
Orum Balance API
Orum Book Transfers API
Orum Businesses API
Orum Cards API
Orum Eligibility API
Orum External Accounts API
Orum Persons API
Orum Reports API
Orum Schedules API
Orum Secure webhooks API
Orum Subledgers API
Where this information came from

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