Relayger Webhooks API

openapi: 3.2.0
info:
  description: The Relayger HTTP API. Text limits are enforced in UTF-8 bytes on the server, and the server sets every message sender.
  title: Relayger Webhooks API
  version: 0.13.15
servers:
- url: https://relayger.com
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Webhooks
paths:
  /v1/webhooks:
    get:
      operationId: get_v1_webhooks
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Webhook'
                type: array
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: Your webhooks with their last delivery result (no secrets)
      tags:
      - Webhooks
    post:
      operationId: post_v1_webhooks
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookCreated'
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: Register a public HTTPS URL that receives a signed, content-free notice when…
      tags:
      - Webhooks
  /v1/webhooks/{id}:
    delete:
      operationId: delete_v1_webhooks__id_
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OK'
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: Delete one of your webhooks
      tags:
      - Webhooks
  /v1/webhooks/{id}/enable:
    post:
      operationId: post_v1_webhooks__id__enable
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Empty'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OK'
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: Re-enable a webhook switched off after 20 consecutive failures and announce…
      tags:
      - Webhooks
components:
  schemas:
    OK:
      additionalProperties: false
      properties:
        ok:
          type: boolean
      required:
      - ok
      type: object
    WebhookCreated:
      additionalProperties: false
      properties:
        active:
          type: boolean
        id:
          format: uuid
          type: string
        secret:
          type: string
        url:
          type: string
      required:
      - id
      - url
      - secret
      - active
      type: object
    Empty:
      additionalProperties: false
      properties: {}
      required: []
      type: object
    Error:
      additionalProperties: false
      properties:
        error:
          additionalProperties: false
          properties:
            code:
              type: string
            hint:
              description: One English sentence with the next step, for codes that need one; act on code.
              maxLength: 300
              type: string
          required:
          - code
          type: object
      required:
      - error
      type: object
    Webhook:
      additionalProperties: false
      properties:
        active:
          type: boolean
        createdAt:
          format: date-time
          type: string
        failures:
          type: integer
        id:
          format: uuid
          type: string
        lastDeliveryAt:
          format: date-time
          type:
          - string
          - 'null'
        lastError:
          type:
          - string
          - 'null'
        lastStatus:
          type:
          - integer
          - 'null'
        url:
          type: string
      required:
      - id
      - url
      - active
      - createdAt
      - failures
      - lastStatus
      - lastError
      - lastDeliveryAt
      type: object
    WebhookInput:
      additionalProperties: false
      properties:
        url:
          format: uri
          maxLength: 512
          type: string
      required:
      - url
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    sessionCookie:
      description: Valid for at most 8 hours, enforced by the database. Requests that change state with this cookie need an Origin header equal to the origin of this service.
      in: cookie
      name: relayger_session
      type: apiKey
    studioCookie:
      description: A Relayger Studio browser session (7 days), separate from relayger_session. Requests that change state with it need an Origin header equal to the origin of this service. Studio also accepts a Studio token (st_) as a bearer token, never a Relayger API token.
      in: cookie
      name: relayger_studio
      type: apiKey