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

Ostrom Webhooks API

Describe how to create webhooks and receive notifications from our system.

Ostrom Webhooks API is one of 7 APIs that Ostrom 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 5 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 2023-11-01.

Requests are made against 4 base URLs: https://sandbox.ostrom-api.io, https://production.ostrom-api.io, https://auth.sandbox.ostrom-api.io, https://auth.production.ostrom-api.io.

5 operations 3 paths 10 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-11-01
Base URL
https://production.ostrom-api.io
Authentication
OAuth 2.0, HTTP Basic
Resource Areas
1

Authentication & Security 2

Ostrom Webhooks API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (ClientAccessToken) using the clientCredentials flow. It accepts HTTP basic authentication (OAuth2BasicAuth).

  • ClientAccessToken — A ClientAccessToken is obtained via the [OAuth 2.0 Client Credentials grant](https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/) and carrie…

Paths & Operations 5

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

Webhooks 5

Describe how to create webhooks and receive notifications from our system.

POST
/webhooks
Create a new webhook
createWebhook body → 200400401429
GET
/webhooks
Retrieve all webhooks
getWebhooks → 200400401404429
GET
/webhooks/{id}
Retrieve a webhook
getWebhook 1 param → 200400401404429
DELETE
/webhooks/{id}
Delete a webhook
deleteWebhook 1 param → 200400401404429
POST
/webhooks/{id}/test
Test a webhook
testWebhook 1 param → 200400401404429

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are DeleteWebhookResponse (3 properties), GetWebhookResponse (3 properties), TestWebhookResponse (3 properties), CreateWebhookResponse (3 properties). Each schema is shown below with its type and property counts.

GetWebhookResponse
object
3 properties
BadRequestError400
object
2 properties
CreateWebhookResponse
object
3 properties
UnauthorizedError401
object
2 properties
TestWebhookResponse
object
3 properties
GetWebhooksItemResponse
object
3 properties
TooManyRequestError429
object
2 properties
DeleteWebhookResponse
object
3 properties
GetWebhooksResponse
object
1 property
BadRequestError404
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ostrom-webhooks-api-openapi.yml Raw ↑

Other APIs Ostrom publishes across the network.

Ostrom Auth API
Ostrom Contracts API
Ostrom Orders API
Ostrom Prices API
Ostrom Products API
Ostrom Users API
Where this information came from

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