Inboxy Webhooks API

openapi: 3.2.0
info:
  title: inboxy Webhooks API
  version: 0.3.0
  summary: Read + manage your inboxy.net inbox programmatically.
  description: 'REST surface over the inboxy alias inbox. Mint aliases, list/search/read

    messages, fetch attachments, manage your API keys, and emit user-initiated

    mail under one of your aliases.


    Mail-emitting paths (`POST /v1/messages/{id}/reply`, `POST /v1/mail/send`,

    `POST /v1/mail/invite`) are recipient-locked and alias-locked server-side:

    the `From:` is always one of the caller''s `@inboxy.net` aliases, the

    recipient is validated against per-user caps and the abuse rules in

    `packages/reply`, and every external message carries the mandatory

    inboxy attribution footer. There is no arbitrary-`From:` send path.


    All endpoints require a bearer API key created from the inboxy.net web UI

    at `/account/keys` (mint is gated by step-up and lives only on the web — there

    is no API-channel mint). Pass it as `Authorization: Bearer ik_…`.


    The signed-token attachment download URLs (`/v1/attachments/{token}/download`,

    `/v1/messages/raw/{token}/download`) are public-by-token — they intentionally

    bypass bearer auth and are not listed here. Obtain them via the JSON

    endpoints below.'
  contact:
    name: inboxy
    url: https://inboxy.net
  license:
    name: Proprietary
servers:
- url: https://api.inboxy.net
  description: Production
security:
- bearerAuth: []
tags:
- name: Webhooks
  description: Outbound event notifications (paid plans).
paths:
  /v1/webhooks:
    get:
      tags:
      - Webhooks
      summary: List your webhooks
      description: Never includes the signing secret — only mint/rotate responses do.
      responses:
        '200':
          description: Webhooks.
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhooks:
                    type: array
                    items:
                      $ref: '#/components/schemas/Webhook'
      operationId: getV1Webhooks
      x-operation-id-source: derived
    post:
      tags:
      - Webhooks
      summary: Register a webhook endpoint
      description: Requires `manage` scope on a paid plan (`paid_feature`, 403, on free). Gated by the plan's `webhook_limit` (`cap_reached`, 403, body carries `used`/`limit`). `url` must be HTTPS and is SSRF-checked (`invalid_url`, 400) before the row is created. The response's `secret` is shown once — store it; it signs the `X-Inboxy-Signature` header on every delivery.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreate'
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
      operationId: postV1Webhooks
      x-operation-id-source: derived
  /v1/webhooks/{id}:
    delete:
      tags:
      - Webhooks
      summary: Delete a webhook
      description: Requires `manage` scope.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Deleted.
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: deleteV1WebhooksById
      x-operation-id-source: derived
  /v1/webhooks/{id}/rotate-secret:
    post:
      tags:
      - Webhooks
      summary: Rotate a webhook's signing secret
      description: Requires `manage` scope. Invalidates the previous secret immediately; the new value is shown once in this response.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Rotated.
          content:
            application/json:
              schema:
                type: object
                required:
                - secret
                properties:
                  secret:
                    type: string
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: postV1WebhooksByIdRotateSecret
      x-operation-id-source: derived
components:
  responses:
    NotFound:
      description: No matching resource owned by the caller.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Malformed request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Token lacks the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - bad_request
          - unauthorized
          - forbidden
          - not_found
          - gone
          - rate_limited
          - internal
          - invalid_token
          - blocked
        message:
          type: string
    WebhookCreate:
      type: object
      required:
      - url
      properties:
        url:
          type: string
          format: uri
          description: HTTPS only; must not resolve to a private/reserved address.
    Webhook:
      type: object
      required:
      - id
      - url
      - enabled
      - consecutive_failures
      - created_at
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
          format: uri
        enabled:
          type: boolean
          description: Auto-disabled after 5 consecutive delivery failures.
        consecutive_failures:
          type: integer
          minimum: 0
        last_status:
          type:
          - string
          - 'null'
        last_delivery_at:
          type:
          - integer
          - 'null'
          description: Unix seconds.
        created_at:
          type: integer
        secret:
          type: string
          description: Plaintext signing secret. Only present in the response to `POST /v1/webhooks` and `POST /v1/webhooks/{id}/rotate-secret` — never returned by `GET /v1/webhooks`.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ik_…
      description: Static API key. Three scopes — `read` (everything except mutations), `manage` (mutations other than sending) and `send` (`/v1/mail/send`, replies, invites). Mint at https://inboxy.net/account/keys (the web UI gates mint with step-up; there is no API-channel mint).