Webhook Relay Api API

swagger: '2.0'
info:
  version: '1.0'
  title: "Webhook Relay"
  description: |
    # Introduction
    Fast, secure tunnels to your internal networks. [Webhook Relay](https://webhookrelay.com) allows you to expose your localhost 
    or any other server in private network to the public internet without configuring port forwarding 
    or firewalls. 
    This API is documented in **Swagger format**. Webhook Relay allows to dynamically configure your tunnels and webhook forwarding and request/response 
    transformation using serverless functions.
        
    # Available authentication methods
    Webhook Relay offers three forms of authentication:
      - **Basic Auth** - only available for non-OAuth accounts. Use your username and password.
      - **API Key** - available for all accounts, token pairs can be generated [here](https://my.webhookrelay.com/tokens)
      - **JWT** - mainly used by the [admin dashboard](https://my.webhookrelay.com) with a 'Authorization Bearer: token' 
    
    You can find Swagger and OpenAPI spec files here: [https://github.com/webhookrelay/swagger-webhookrelay](https://github.com/webhookrelay/swagger-webhookrelay).

  termsOfService: "https://webhookrelay.com/tos/"
  contact:
    email: "support@webhookrelay.com"
externalDocs:
  description: Find out more in the official documentation.
  url: 'https://webhookrelay.com/docs'
host: my.webhookrelay.com
basePath: /
schemes:
- "https"
consumes:
- application/json
produces:
- application/json
tags:
  - name: Tokens
    description: Token key & secret pairs are used to authenticate your API calls or for agents to subscribe to webhook forwarding or open tunnels.
  - name: Buckets
    description: Input and output grouping. Bucket allows to have multiple endpoints for the same destination or multiple destinations for fan-out style webhook forwarding.
  - 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.
  - name: Inputs
    description: "Inputs are your public endpoints. Each input serves as an inbox that you can supply to your webhooks producer (ie: Github, Docker, IFTTT)"
  - name: Logs
    description: "Webhook logs hold the status of received and forwarded webhooks. You can use this API group to resend webhooks to one or more destinations"
  - name: Functions
    description: |
      Webhook Relay Functions provide an easy way to extract values from webhooks and transform HTTP 
      requests before passing them to their final destination. Function can be reused by any number 
      of Inputs and/or Outputs. Since user doesn’t have to run a server, this type of function service 
      is also known as FaaS (Function as a Service) or Serverless. 

      Read more about functions here: https://webhookrelay.com/docs/webhooks/functions/manipulating-json.

      Basic function examples can be found here: https://webhookrelay.com/docs/webhooks/functions/modify-request.
  - name: Tunnels
    description: |
      Tunnels allow remote access to internal web services such as local Wordpress, Jekyll or Hexo. Recommended `crypto` options are `flexible` or `tls-pass-through`.  
        
x-tagGroups:
  - name: Authentication
    tags:
      - Tokens
  - name: Webhook Forwarding
    tags:
      - Buckets
      - Outputs
      - Inputs
      - Logs
      - Functions


# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webhook-relay/refs/heads/main/openapi/_original/webhook-relay-api-openapi.yml