Webhook Relay Outputs API
Outputs are destinations, where your webhooks will be forwarded. Public destinations do not require agents to be running. Internal outputs will not work without an agent.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/webhook-relay:webhook-relay-outputs-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: '1.0'
title: Webhook Relay Outputs API
description: '# Introduction
Fast, secure tunnels to your internal networks.'
termsOfService: https://webhookrelay.com/tos/
contact:
email: support@webhookrelay.com
servers:
- url: https://my.webhookrelay.com/
tags:
- name: Outputs
description: Outputs are destinations, where your webhooks will be forwarded. Public destinations do not require agents to be running. Internal outputs will not work without an agent.
paths:
/v1/buckets/{bucketID}/outputs:
x-summary: Manage bucket outputs
parameters:
- name: bucketID
in: path
description: ID of a bucket to create output in
required: true
schema:
type: string
post:
tags:
- Outputs
description: Create one or more outputs for the bucket to start forwarding webhooks to those destinations.
summary: Create a New Output
responses:
201:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Output'
400:
description: Invalid output request supplied
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Output'
required: true
operationId: postV1BucketsByBucketIDOutputs
x-operation-id-source: derived
/v1/buckets/{bucketID}/outputs/{outputID}:
x-summary: Manage bucket outputs
parameters:
- name: bucketID
in: path
description: ID of a bucket to create input in
required: true
schema:
type: string
- name: outputID
in: path
description: ID of an output to manage
required: true
schema:
type: string
put:
tags:
- Outputs
description: Update output destination or make it public/internal.
summary: Update Output
responses:
200:
description: Output updated
content:
application/json:
schema:
$ref: '#/components/schemas/Output'
400:
description: Invalid output request supplied
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Output'
required: true
operationId: putV1BucketsByBucketIDOutputsByOutputID
x-operation-id-source: derived
delete:
tags:
- Outputs
summary: Delete Output
responses:
200:
description: ''
404:
description: Output or Bucket not found
operationId: deleteV1BucketsByBucketIDOutputsByOutputID
x-operation-id-source: derived
components:
schemas:
AndRule:
title: And Rule
type: array
items:
$ref: '#/components/schemas/Rules'
HeaderItem:
title: Header values
type: array
items:
type: string
NotRule:
title: Not Rule
type: array
items:
$ref: '#/components/schemas/Rules'
Output:
title: Output
type: object
properties:
id:
type: string
readOnly: true
created_at:
type: integer
readOnly: true
updated_at:
type: integer
readOnly: true
bucket_id:
type: string
readOnly: true
name:
type: string
disabled:
type: boolean
description: Allows to disable specific output destination without deleting the output itself.
internal:
type: boolean
description: When internal output receives webhook, it forwards it to any connected agent (relay CLI, Docker agent or WebSocket connection)
tls_verification:
type: boolean
description: Enforce TLS verification where possible (internal and public destinations)
destination:
type: string
description: Destination, where to forward the webhook, such as 'http://localhost:4000'
headers:
type: object
description: Headers to override (for example Host)
$ref: '#/components/schemas/Headers'
rules:
type: object
description: Request matching rules, documentation can be found here https://webhookrelay.com/docs/webhooks/public/public-destination
$ref: '#/components/schemas/Rules'
timeout:
type: integer
description: Timeout in seconds, value between 0 and 180
description:
type: string
function_id:
type: string
description: ID of the function that will be executed for this output
OrRule:
title: Or Rule
type: array
items:
$ref: '#/components/schemas/Rules'
RuleParameter:
title: RuleParameter
type: object
properties:
name:
type: string
source:
type: string
enum:
- header
- payload
- query
Headers:
title: Headers for request/response
type: object
additionalProperties:
$ref: '#/components/schemas/HeaderItem'
description: A hashmap of header keys and a list of values for each string, Go equivalent map[string][]string
example:
Content-Type:
- JSON
Foo:
- Bar
MatchRule:
title: Match Rule
type: object
properties:
parameter:
type: object
$ref: '#/components/schemas/RuleParameter'
type:
type: string
enum:
- value
- contains
- does-not-contain
- regex
- payload-hash-sha1
- payload-hash-sha256
value:
type: string
substring:
type: string
regex:
type: string
secret:
type: string
Rules:
title: Rules
type: object
properties:
and:
type: object
$ref: '#/components/schemas/AndRule'
or:
type: object
$ref: '#/components/schemas/OrRule'
not:
type: object
$ref: '#/components/schemas/NotRule'
match:
type: object
$ref: '#/components/schemas/MatchRule'
externalDocs:
description: Find out more in the official documentation.
url: https://webhookrelay.com/docs
x-tagGroups:
- name: Authentication
tags:
- Tokens
- name: Webhook Forwarding
tags:
- Buckets
- Outputs
- Inputs
- Logs
- Functions
- name: Tunneling
tags:
- Tunnels