Commentary Webhooks API

The Webhooks API from Commentary — 6 operation(s) for webhooks.

GitHub OpenAPI

Operations 8

GET /api/v1/webhook-subscriptions List workspace webhook subscriptions #
POST /api/v1/webhook-subscriptions Create a scoped webhook subscription and reveal its signing secret once #
GET /api/v1/webhook-subscriptions/{subscriptionId} Get a webhook subscription without its secret #
PATCH /api/v1/webhook-subscriptions/{subscriptionId} Conditionally update endpoint or event scopes #
POST /api/v1/webhook-subscriptions/{subscriptionId}/disable Disable delivery and cancel pending attempts #
POST /api/v1/webhook-subscriptions/{subscriptionId}/rotate-secret Rotate and reveal a new signing secret once #
GET /api/v1/webhook-subscriptions/{subscriptionId}/deliveries List filtered redacted delivery diagnostics and dead letters #
POST /api/v1/webhook-subscriptions/{subscriptionId}/deliveries/{deliveryId}/replay Confirm replay of one delivery as a new delivery id #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/commentary-dev:commentary-dev-webhooks-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

commentary-dev-webhooks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Commentary Dev Webhooks API
  version: 0.1.0
  x-commentary-api-version: v1
  x-commentary-compatibility-policy: /docs/api/versioning.md
  x-commentary-feature-key: api.openapi_docs
  description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: commentary-dev-openapi.json, commentary-dev-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://commentary.dev
  description: Configured Commentary origin.
- url: http://localhost:3000
  description: Local development.
tags:
- name: Webhooks
paths:
  /api/v1/webhook-subscriptions:
    get:
      operationId: listWebhookSubscriptions
      tags:
      - Webhooks
      summary: List workspace webhook subscriptions
      description: Owner/admin only. Secrets are never returned by reads.
      security:
      - bearerAuth:
        - commentary.webhooks.read
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: cursor
        in: query
        required: false
        schema:
          type: string
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      x-commentary-feature-key: interactions.webhooks
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '403':
          description: The token or session does not have permission for this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '429':
          description: The request was rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
    post:
      operationId: createWebhookSubscription
      tags:
      - Webhooks
      summary: Create a scoped webhook subscription and reveal its signing secret once
      description: Owner/admin only. HTTPS destinations are DNS-resolved and SSRF-checked. Idempotency-Key makes creation retry-safe.
      security:
      - bearerAuth:
        - commentary.webhooks.write
      parameters:
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          maxLength: 200
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - endpointUrl
              - eventTypes
              additionalProperties: false
              properties:
                endpointUrl:
                  type: string
                  format: uri
                  pattern: ^https://
                eventTypes:
                  type: array
                  minItems: 1
                  uniqueItems: true
                  items:
                    type: string
                    enum:
                    - interaction.created.v1
                    - interaction.updated.v1
                    - interaction.revision.created.v1
                    - interaction.decision.recorded.v1
                    - interaction.fulfillment.updated.v1
                    - interaction.terminal.v1
                    - interaction.content_purged.v1
      x-commentary-feature-key: interactions.webhooks
      responses:
        '201':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                description: The data.secret field is displayed only in this response.
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '403':
          description: The token or session does not have permission for this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '429':
          description: The request was rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
    servers:
    - url: https://commentary.dev
      description: Configured Commentary origin.
    - url: http://localhost:3000
      description: Local development.
  /api/v1/webhook-subscriptions/{subscriptionId}:
    get:
      operationId: getWebhookSubscription
      tags:
      - Webhooks
      summary: Get a webhook subscription without its secret
      security:
      - bearerAuth:
        - commentary.webhooks.read
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
          pattern: ^whs_
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      x-commentary-feature-key: interactions.webhooks
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '403':
          description: The token or session does not have permission for this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '429':
          description: The request was rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
    patch:
      operationId: updateWebhookSubscription
      tags:
      - Webhooks
      summary: Conditionally update endpoint or event scopes
      security:
      - bearerAuth:
        - commentary.webhooks.write
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
          pattern: ^whs_
      - name: If-Match
        in: header
        required: true
        schema:
          type: string
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                endpointUrl:
                  type: string
                  format: uri
                  pattern: ^https://
                eventTypes:
                  type: array
                  minItems: 1
                  uniqueItems: true
                  items:
                    type: string
                    enum:
                    - interaction.created.v1
                    - interaction.updated.v1
                    - interaction.revision.created.v1
                    - interaction.decision.recorded.v1
                    - interaction.fulfillment.updated.v1
                    - interaction.terminal.v1
                    - interaction.content_purged.v1
      x-commentary-feature-key: interactions.webhooks
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '403':
          description: The token or session does not have permission for this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '412':
          description: The ETag is stale.
        '428':
          description: If-Match is required.
        '429':
          description: The request was rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
    servers:
    - url: https://commentary.dev
      description: Configured Commentary origin.
    - url: http://localhost:3000
      description: Local development.
  /api/v1/webhook-subscriptions/{subscriptionId}/disable:
    post:
      operationId: disableWebhookSubscription
      tags:
      - Webhooks
      summary: Disable delivery and cancel pending attempts
      security:
      - bearerAuth:
        - commentary.webhooks.write
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
          pattern: ^whs_
      - name: If-Match
        in: header
        required: true
        schema:
          type: string
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      x-commentary-feature-key: interactions.webhooks
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '403':
          description: The token or session does not have permission for this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '429':
          description: The request was rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
    servers:
    - url: https://commentary.dev
      description: Configured Commentary origin.
    - url: http://localhost:3000
      description: Local development.
  /api/v1/webhook-subscriptions/{subscriptionId}/rotate-secret:
    post:
      operationId: rotateWebhookSubscriptionSecret
      tags:
      - Webhooks
      summary: Rotate and reveal a new signing secret once
      description: The prior secret stops signing new attempts immediately; later reads never redisplay either secret.
      security:
      - bearerAuth:
        - commentary.webhooks.write
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
          pattern: ^whs_
      - name: If-Match
        in: header
        required: true
        schema:
          type: string
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      x-commentary-feature-key: interactions.webhooks
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '403':
          description: The token or session does not have permission for this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '429':
          description: The request was rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
    servers:
    - url: https://commentary.dev
      description: Configured Commentary origin.
    - url: http://localhost:3000
      description: Local development.
  /api/v1/webhook-subscriptions/{subscriptionId}/deliveries:
    get:
      operationId: listWebhookDeliveries
      tags:
      - Webhooks
      summary: List filtered redacted delivery diagnostics and dead letters
      description: Returns data and nullable nextCursor for bounded older-delivery navigation. Response bodies are whitespace-normalized, size-bounded excerpts; request headers, secrets, and raw payload diagnostics are never returned.
      security:
      - bearerAuth:
        - commentary.webhooks.read
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
          pattern: ^whs_
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      x-commentary-feature-key: interactions.webhooks
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '403':
          description: The token or session does not have permission for this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '429':
          description: The request was rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
    servers:
    - url: https://commentary.dev
      description: Configured Commentary origin.
    - url: http://localhost:3000
      description: Local development.
  /api/v1/webhook-subscriptions/{subscriptionId}/deliveries/{deliveryId}/replay:
    post:
      operationId: replayWebhookDelivery
      tags:
      - Webhooks
      summary: Confirm replay of one delivery as a new delivery id
      description: Replay reports state only; it never executes or approves an action.
      security:
      - bearerAuth:
        - commentary.webhooks.write
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
          pattern: ^whs_
      - name: deliveryId
        in: path
        required: true
        schema:
          type: string
          pattern: ^whd_
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - confirm
              additionalProperties: false
              properties:
                confirm:
                  const: true
      x-commentary-feature-key: interactions.webhooks
      responses:
        '202':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '403':
          description: The token or session does not have permission for this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
        '429':
          description: The request was rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalError'
    servers:
    - url: https://commentary.dev
      description: Configured Commentary origin.
    - url: http://localhost:3000
      description: Local development.
components:
  schemas:
    ExternalError:
      type: object
      required:
      - ok
      - error
      properties:
        ok:
          const: false
        error:
          type: string
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Commentary external access token
      description: Bearer token from an API token, OAuth authorization code flow, OAuth refresh token flow, or OAuth device flow.
    commentarySession:
      type: apiKey
      in: cookie
      name: commentary_session
      description: Signed-in Commentary browser session. Used for API token management routes.
x-refined-from:
- commentary-dev-openapi.json


# --- truncated at 32 KB (495 KB total) ---
# Full source: https://artifacts.apis.io/commentary-dev/openapi/commentary-dev-webhooks-api-openapi.yml