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

OpenRelay Webhooks API

Subscribe to platform events with signed HTTP callbacks.

OpenRelay Webhooks API is one of 19 APIs that OpenRelay 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, API documentation, and an API reference.

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

Requests are made against 3 base URLs: https://api.openrelay.inc, https://api.beta.openrelay.inc, http://localhost:8083.

7 operations 6 paths 10 schemas 1 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.openrelay.inc
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

OpenRelay Webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiKey).

  • apiKey — OpenRelay API key. Send it as Authorization: Bearer vl….

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

Subscribe to platform events with signed HTTP callbacks.

GET
/v1/orgs/{orgId}/webhooks
List an org's webhooks (no secrets)
listOrgWebhooks 1 param → 200401403
POST
/v1/orgs/{orgId}/webhooks/create
Create a webhook (returns the signing secret once)
createOrgWebhook 1 param body → 200401403
DELETE
/v1/orgs/{orgId}/webhooks/{id}
Delete a webhook
deleteOrgWebhook 2 params → 204401403
PATCH
/v1/orgs/{orgId}/webhooks/{id}
Update a webhook (name/url/events)
updateOrgWebhook 2 params body → 200401403404
GET
/v1/orgs/{orgId}/webhooks/{id}/deliveries
Recent delivery attempts for a webhook
listOrgWebhookDeliveries 3 params → 200400401403404
POST
/v1/orgs/{orgId}/webhooks/{id}/regenerate-secret
Regenerate a webhook's signing secret (returned once)
regenerateOrgWebhookSecret 2 params → 200401403404
POST
/v1/orgs/{orgId}/webhooks/{id}/toggle
Enable/disable a webhook
toggleOrgWebhook 2 params body → 200401403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are WebhookDeliveryItem (9 properties), WebhookWithSecret (8 properties), WebhookSummary (8 properties), WebhookUpdateResult (4 properties). Each schema is shown below with its type and property counts.

WebhookUpdateResult
object
4 properties 4 required
WebhookSecret
object
3 properties 3 required
WebhookWithSecret
object
8 properties 8 required
WebhookDeliveryItem
object
9 properties 6 required
UpdateWebhookRequest
object
3 properties
WebhookSummary
object
8 properties 8 required
ToggleWebhookRequest
object
1 property 1 required
Error
object
2 properties 1 required
WebhookToggleResult
object
2 properties 2 required
CreateWebhookRequest
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openrelay-webhooks-api-openapi.yml Raw ↑

Other APIs OpenRelay publishes across the network.

OpenRelay Inference API
OpenRelay Account API
OpenRelay API Keys API
OpenRelay Batches API
OpenRelay Billing API
OpenRelay Catalog API
OpenRelay Clusters API
OpenRelay Files API
OpenRelay Internal API
OpenRelay Organizations API
OpenRelay Provider API
OpenRelay Registry Credentials API
Where this information came from

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