IntegrationOS

IntegrationOS Webhook Relay API

Manage webhook relay endpoints, events, and deliveries

GitHub OpenAPI
Business capability
Webhook & Event Subscription Management BC-4270.80

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/webhooks/relay List my webhook relay endpoints · List relay endpoints #
Ask an LLM
“Which webhook relay endpoints have been set up under my key?”
“Can I page through relay endpoints across my personal, org or project scope?”
Tell an agent
List my webhook relay endpoints.
Show page {page} of relay endpoints, {limit} per page.
POST /v1/webhooks/relay Create a webhook relay endpoint on a connection · Create relay endpoint #
Ask an LLM
“How do I start receiving a connected platform's webhooks for one of my connections?”
“Can I choose which event types trigger a relay endpoint when I create it?”
Tell an agent
Create a webhook relay endpoint for connection {connectionKey}.
Register a relay endpoint on connection {connectionKey} filtered to events {eventFilters}.
GET /v1/webhooks/relay/config/{conn_def_id} Get webhook setup instructions for a connector · Get webhook relay setup config #
Ask an LLM
“What URL do I paste into the upstream platform to set up webhook relay for a connector?”
“Which fields and steps does a connector need before its webhooks can be relayed?”
Tell an agent
Show the webhook relay setup instructions for connector definition {conn_def_id}.
Get the relay inbound URL and required fields for connector {conn_def_id}.
GET /v1/webhooks/relay/event-types List the webhook event types a platform sends · List webhook relay event types #
Ask an LLM
“Which webhook event types can a given platform deliver through the relay?”
“Can I search a platform's event types by keyword to build a picker?”
Tell an agent
List the webhook event types platform {platform} can deliver.
Find {platform} event types matching "{search}".
GET /v1/webhooks/relay/events List inbound webhook events the relay received · List relay events #
Ask an LLM
“What webhook deliveries has the relay received from upstream platforms?”
“Can I filter received relay events by connection, event type or time range?”
Tell an agent
List inbound webhook events received by the relay.
Show relay events of type {eventType} on connection {connectionId} received after {after}.
GET /v1/webhooks/relay/events/{id} Get one inbound webhook event and its payload · Get relay event #
Ask an LLM
“How do I see the raw payload an upstream platform sent for a specific webhook event?”
“Can I inspect a single received relay event by its ID?”
Tell an agent
Get relay event {id} with its raw payload.
Show me what the upstream platform sent in inbound event {id}.
GET /v1/webhooks/relay/events/{id}/deliveries List delivery attempts for a relay event · List deliveries for a relay event #
Ask an LLM
“Why did a received webhook event not reach one of my endpoints?”
“Can I see every retry the relay made when forwarding a particular event?”
Tell an agent
List the delivery attempts made for relay event {id}.
Show which endpoints inbound event {id} was forwarded to and how each try went.
POST /v1/webhooks/relay/incoming/{platform}/{connection_key} Accept an inbound webhook from a platform · Receive inbound webhook delivery #
Ask an LLM
“What is the inbound URL upstream platforms post webhooks to for a connection?”
“Does the relay verify the signature of an incoming webhook before forwarding it?”
Tell an agent
Deliver an inbound webhook from platform {platform} for connection {connection_key}.
Post a test upstream delivery to the relay's incoming URL for {platform} connection {connection_key}.
POST /v1/webhooks/relay/organizations/{org_id}/projects/{project_id}/{id}/activate Activate a project relay endpoint · Activate project relay endpoint #
Ask an LLM
“How do I turn on a relay endpoint that belongs to a project so events start flowing?”
“Can I supply a webhook secret when activating a project-scoped relay endpoint?”
Tell an agent
Activate relay endpoint {id} in project {project_id}, org {org_id}, with actions {actions}.
Start event flow for project {project_id} relay {id} in org {org_id} using actions {actions} and secret {webhookSecret}.
POST /v1/webhooks/relay/organizations/{org_id}/{id}/activate Activate an organization relay endpoint · Activate organization relay endpoint #
Ask an LLM
“How do I activate a relay endpoint owned by my organization rather than a project?”
“What actions must I pass to switch on an org-level relay endpoint?”
Tell an agent
Activate organization {org_id} relay endpoint {id} with actions {actions}.
Register org-level relay {id} in {org_id} upstream, running {actions} on each event.
GET /v1/webhooks/relay/platforms List platforms that can send relayed webhooks · List webhook relay platforms #
Ask an LLM
“Which platforms can I receive inbound webhooks from through the relay?”
“How many event types does each relay-supported platform emit?”
Tell an agent
List the platforms supported by webhook relay.
Show each relay platform with its count of event types.
DELETE /v1/webhooks/relay/{id} Delete a webhook relay endpoint · Delete relay endpoint #
Ask an LLM
“How do I stop relaying webhooks to an endpoint and remove it?”
“Will events already in flight still be delivered after I delete a relay endpoint?”
Tell an agent destructive · confirm first
Delete relay endpoint {id}.
Remove relay endpoint {id} and deactivate its upstream webhook.
GET /v1/webhooks/relay/{id} Get a relay endpoint's configuration · Get relay endpoint #
Ask an LLM
“What event types and actions is a particular relay endpoint configured with?”
“Can I check whether a relay endpoint is currently active?”
Tell an agent
Get relay endpoint {id}.
Show the connection, subscribed events and active status of relay endpoint {id}.
PATCH /v1/webhooks/relay/{id} Update a webhook relay endpoint · Update relay endpoint #
Ask an LLM
“Can I change which event types an existing relay endpoint listens for?”
“How do I pause a relay endpoint without deleting it?”
Tell an agent
Change relay endpoint {id} to filter events {eventFilters}.
Set relay endpoint {id} active to {active}.
POST /v1/webhooks/relay/{id}/activate Activate a relay endpoint so events flow · Activate relay endpoint #
Ask an LLM
“Why isn't my newly created relay endpoint receiving any events?”
“Which actions do I specify when activating my own relay endpoint?”
Tell an agent
Activate relay endpoint {id} with actions {actions}.
Register my relay endpoint {id} upstream using actions {actions} and webhook secret {webhookSecret}.
GET /v1/webhooks/relay/{id}/deliveries List deliveries sent to a relay endpoint · List deliveries for a relay endpoint #
Ask an LLM
“Are deliveries to a specific relay endpoint succeeding or failing?”
“Can I see the recent traffic a relay endpoint has received?”
Tell an agent
List the deliveries attempted against relay endpoint {id}.
Show recent traffic and failures for endpoint {id}.

Documentation

📖
APIReference
https://www.withone.ai/docs/api-reference/introduction
📖
GettingStarted
https://www.withone.ai/docs/getting-started
📖
Documentation
https://www.withone.ai/docs/welcome

Specifications

⚙
OpenAPI
https://artifacts.apis.io/integration-os/openapi/integration-os-webhook-relay-api-openapi.yml

Other Resources

🔗
ToolCrosswalk
https://artifacts.apis.io/integration-os/mcp/integration-os-tool-crosswalk.yml
🔗
Webhooks
https://artifacts.apis.io/integration-os/asyncapi/integration-os-webhooks.yml
🔗
ErrorCatalog
https://artifacts.apis.io/integration-os/errors/integration-os-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/integration-os/data-model/integration-os-data-model.yml
🔗
Portal
https://withone.ai
🔗
Blog
https://www.withone.ai/blog
🔗
KnowledgeBase
https://www.withone.ai/knowledge
🔗
Signup
https://app.withone.ai
🔗
Login
https://app.withone.ai
🔗
GitHubOrg
https://github.com/withoneai
🔗
GitHubRepo
https://github.com/withoneai/knowledge
🔗
Rules
https://artifacts.apis.io/integration-os/rules/integration-os-rules.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/integration-os:integration-os-webhook-relay-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

integration-os-webhook-relay-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: The One API. Universal API integration platform for AI agents and applications.
  license:
    name: ''
  title: One Webhook Relay API
  version: 5.35.0
tags:


# --- truncated at 32 KB (57 KB total) ---
# Full source: https://artifacts.apis.io/integration-os/openapi/integration-os-webhook-relay-api-openapi.yml