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

IntegrationOS Webhook Relay API

Manage webhook relay endpoints, events, and deliveries

IntegrationOS Webhook Relay API is one of 31 APIs that IntegrationOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook Relay. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, a getting-started guide, API documentation, and an engineering blog.

This API exposes 16 operations across 13 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 5.35.0.

Requests are made against the base URL https://api.withone.ai.

16 operations 13 paths 17 schemas 1 DELETE9 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.35.0
Base URL
https://api.withone.ai
Authentication
HTTP Bearer, OAuth 2.0, API Key, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 7

IntegrationOS Webhook Relay API declares 7 security schemes for authenticating requests. It accepts HTTP bearer tokens (Bearer). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 38 scopes. An API key is passed in the cookie as withone (Session). An API key is passed in the header as X-One-Connection-Key (X-One-Connection-Key). An API key is passed in the header as X-One-Secret (X-One-Secret). An API key is passed in the header as X-One-Connection-Key (X-Pica-Connection-Key). An API key is passed in the header as X-One-Secret (X-Pica-Secret).

Paths & Operations 16

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

Webhook Relay 16

Manage webhook relay endpoints, events, and deliveries

GET
/v1/webhooks/relay
List relay endpoints
list_relay_endpoints 3 params → 200400401402403404429500
POST
/v1/webhooks/relay
Create relay endpoint
create_relay_endpoint body → 200400401402403404429500
GET
/v1/webhooks/relay/config/{conn_def_id}
Get webhook relay setup config
get_webhook_relay_config 1 param → 200400401402403404429500
GET
/v1/webhooks/relay/event-types
List webhook relay event types
list_webhook_relay_event_types 2 params → 200400401402403404429500
GET
/v1/webhooks/relay/events
List relay events
list_relay_events 8 params → 200400401402403404429500
GET
/v1/webhooks/relay/events/{id}
Get relay event
get_relay_event 1 param → 200400401402403404429500
GET
/v1/webhooks/relay/events/{id}/deliveries
List deliveries for a relay event
list_relay_event_deliveries 1 param → 200400401402403404429500
POST
/v1/webhooks/relay/incoming/{platform}/{connection_key}
Receive inbound webhook delivery
receive_webhook_relay 2 params body → 200400401402403404429500
POST
/v1/webhooks/relay/organizations/{org_id}/projects/{project_id}/{id}/activate
Activate project relay endpoint
activate_project_relay_endpoint 3 params body → 200400401402403404429500
POST
/v1/webhooks/relay/organizations/{org_id}/{id}/activate
Activate organization relay endpoint
activate_organization_relay_endpoint 2 params body → 200400401402403404429500
GET
/v1/webhooks/relay/platforms
List webhook relay platforms
list_webhook_relay_platforms → 200
DELETE
/v1/webhooks/relay/{id}
Delete relay endpoint
delete_relay_endpoint 1 param → 200400401402403404429500
GET
/v1/webhooks/relay/{id}
Get relay endpoint
get_relay_endpoint 1 param → 200400401402403404429500
PATCH
/v1/webhooks/relay/{id}
Update relay endpoint
update_relay_endpoint 1 param body → 200400401402403404429500
POST
/v1/webhooks/relay/{id}/activate
Activate relay endpoint
activate_relay_endpoint 1 param body → 200400401402403404429500
GET
/v1/webhooks/relay/{id}/deliveries
List deliveries for a relay endpoint
list_relay_endpoint_deliveries 1 param → 200400401402403404429500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are WebhookRelayEndpointView (17 properties), WebhookRelayEventView (17 properties), RelayDeliveryView (11 properties), UpdateEndpointParams (6 properties). Each schema is shown below with its type and property counts.

CreateEndpointParams
object
6 properties 1 required
Paginated_WebhookRelayEndpointView
object
4 properties 4 required
RelayActionView
RelayDeliveryView
object
11 properties 7 required
ChangeLog
object
Value
CreateRelayAction
WebhookRelayPlatformInfo
object
2 properties 2 required
ActivateEndpointParams
object
2 properties 1 required
ConnectionDefinitionId
string
Prefixed ID with 'conndef' prefix (e.g., 'conndef1C'), also accepts raw integer
FormDataItem
object
6 properties 4 required
WebhookRelayEventView
object
17 properties 15 required
ErrorResponse
object
5 properties 5 required
Paginated_WebhookRelayEventView
object
4 properties 4 required
UpdateEndpointParams
object
6 properties
WebhookRelayEndpointView
object
17 properties 12 required
WebhookFrontend
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

integration-os-webhook-relay-api-openapi.yml Raw ↑

Other APIs IntegrationOS publishes across the network.

IntegrationOS Access API
IntegrationOS Actions API
IntegrationOS AI Agent Cron Runs API
IntegrationOS AI Agents API
IntegrationOS AI Runner Secrets API
IntegrationOS AI Runners API
IntegrationOS AI Skills API
IntegrationOS Auth Kit API
IntegrationOS Billing API
IntegrationOS Connection Definitions API
IntegrationOS Connection OAuth Definitions API
IntegrationOS Connections API
Where this information came from

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