Webhook Relay Logs API

openapi: 3.2.0
info:
  version: '1.0'
  title: Webhook Relay Logs 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: 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
paths:
  /v1/logs:
    get:
      tags:
      - Logs
      summary: List logs
      parameters:
      - in: query
        name: from
        description: YYYY-MM-DD date from when the logs should be returned, for example '2020-01-01'
        schema:
          type: string
      - in: query
        name: to
        description: YYYY-MM-DD last day till when the logs should be returned, for example '2020-01-02' (includes the last day)
        schema:
          type: string
      - in: query
        name: bucket
        description: Optional bucket ID for filtering logs
        schema:
          type: string
      - in: query
        name: limit
        description: Limit of the logs to return
        schema:
          type: integer
      - in: query
        name: offset
        description: Offset of the logs when querying
        schema:
          type: integer
      - in: query
        name: status
        description: Webhook log status
        schema:
          type: string
          enum:
          - status
          - failed
          - stalled
          - received
          - rejected
      responses:
        200:
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogsResponse'
      operationId: getV1Logs
      x-operation-id-source: derived
  /v1/logs/{logID}/action:
    post:
      tags:
      - Logs
      description: You may resend log to one or more destinations
      summary: Resend log
      parameters:
      - name: logID
        in: path
        required: true
        description: ID of a log
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        400:
          description: Invalid request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogAction'
        required: true
      operationId: postV1LogsByLogIDAction
      x-operation-id-source: derived
components:
  schemas:
    HeaderItem:
      title: Header values
      type: array
      items:
        type: string
    LogAction:
      title: Webhook Log Action
      type: object
      properties:
        action:
          type: string
          description: Log action, for example 'resend'
        output:
          type: string
          description: Optional, only set to an output ID if you want to resend this log to the specific output instead of all bucket outputs
    Log:
      title: Webhook Log
      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
        input_id:
          type: string
          readOnly: true
        output_id:
          type: string
          readOnly: true
        internal:
          type: boolean
          description: When internal output receives webhook, it forwards it to any connected agent (relay CLI, Docker agent or WebSocket connection)
        status_code:
          type: integer
        response_body:
          type: string
        response_headers:
          $ref: '#/components/schemas/Headers'
        status:
          type: string
          description: Request status, example values 'preparing', 'sent', 'failed', 'stalled', 'received', 'rejected'
        retries:
          type: integer
          description: Retries taken so far
        headers:
          $ref: '#/components/schemas/Headers'
        raw_query:
          type: string
          description: raw query for example request to http://example.com?foo=bar is foo=bar
        method:
          type: string
        body:
          type: string
        ephemeral:
          type: boolean
          description: This field is inherited from the bucket, if set - request/response body will not be set
    LogsResponse:
      title: Logs API response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Log'
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
    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
    Response:
      title: Action response
      type: object
      properties:
        id:
          type: string
          description: ID of the object
        status:
          type: string
          description: Status of the action
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