Comma Notifications API

Webhook subscriptions on report events, deliverable as Slack, Discord, or plain JSON payloads.

GitHub OpenAPI

Operations 6

GET /notifications List notification subscriptions #
POST /notifications Create a subscription #
GET /notifications/{id} Fetch one subscription #
PATCH /notifications/{id} Update a subscription #
DELETE /notifications/{id} Delete a subscription #
POST /notifications/{id}/test Send a synthetic test event #

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/commareports-com:commareports-com-notifications-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

commareports-com-notifications-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Commareports Com Notifications API
  version: 1.0.0
  contact:
    url: https://commareports.com/contact
  description: 'Operations tagged Notifications across 2 of this provider''s published API definitions: commareports-com-openapi.json, commareports-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://commareports.com/api/v1
security:
- commaApiToken: []
tags:
- name: Notifications
  description: Webhook subscriptions on report events, deliverable as Slack, Discord, or plain JSON payloads.
paths:
  /notifications:
    get:
      tags:
      - Notifications
      operationId: listNotificationSubscriptions
      summary: List notification subscriptions
      description: 'The token owner''s webhook subscriptions, newest first (max 200). Scope: `routines`.'
      responses:
        '200':
          description: Subscriptions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscriptions:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotificationSubscription'
                required:
                - subscriptions
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      tags:
      - Notifications
      operationId: createNotificationSubscription
      summary: Create a subscription
      description: 'Subscribe a webhook to report events. Omit `report_id` to match every report the owner owns, was invited to, or shares with their team (public link access doesn''t count). `signing_secret` (encrypted at rest, never returned) enables HMAC-signed deliveries. Scope: `routines`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationCreateRequest'
      responses:
        '201':
          description: Subscription created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSubscription'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://commareports.com/api/v1
  /notifications/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Notifications
      operationId: getNotificationSubscription
      summary: Fetch one subscription
      description: 'Owner-scoped. Scope: `routines`.'
      responses:
        '200':
          description: The subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSubscription'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      tags:
      - Notifications
      operationId: updateNotificationSubscription
      summary: Update a subscription
      description: 'Any subset of { name, webhook_url, signing_secret, events, format, enabled, report_id }. Scope: `routines`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPatchRequest'
      responses:
        '200':
          description: Updated subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSubscription'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      tags:
      - Notifications
      operationId: deleteNotificationSubscription
      summary: Delete a subscription
      description: 'Scope: `routines`.'
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://commareports.com/api/v1
  /notifications/{id}/test:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      tags:
      - Notifications
      operationId: testNotificationSubscription
      summary: Send a synthetic test event
      description: 'Delivers a fake `revision.created` event through the real sign/format/deliver pipeline so you can verify the webhook wiring. 200 when the target accepted it, 502 when delivery failed. Scope: `routines`.'
      responses:
        '200':
          description: Delivered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTestResult'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '502':
          description: Delivery failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTestResult'
    servers:
    - url: https://commareports.com/api/v1
components:
  schemas:
    NotificationTestResult:
      type: object
      properties:
        ok:
          type: boolean
        http_status:
          type:
          - integer
          - 'null'
          description: Status returned by the webhook target.
        error:
          type:
          - string
          - 'null'
      required:
      - ok
    NotificationSubscription:
      type: object
      properties:
        id:
          type: string
          format: uuid
        report_id:
          type:
          - string
          - 'null'
          format: uuid
          description: null = every report the owner owns, was invited to, or shares with their team.
        name:
          type: string
        webhook_url:
          type: string
          format: uri
        events:
          type: array
          items:
            type: string
            enum:
            - revision.created
            - comment.created
            - comment.mentioned
            - signoff.submitted
        format:
          type: string
          enum:
          - slack
          - discord
          - plain
        enabled:
          type: boolean
        last_delivered_at:
          type:
          - string
          - 'null'
          format: date-time
        last_delivery_status:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
      - id
      - name
      - webhook_url
      - events
      - format
      - enabled
      - created_at
      - updated_at
    NotificationPatchRequest:
      type: object
      description: At least one property must be present.
      minProperties: 1
      properties:
        name:
          type: string
          maxLength: 200
        webhook_url:
          type: string
          format: uri
          maxLength: 2048
        signing_secret:
          type:
          - string
          - 'null'
          maxLength: 1024
        events:
          type: array
          items:
            type: string
            enum:
            - revision.created
            - comment.created
            - comment.mentioned
            - signoff.submitted
        format:
          type: string
          enum:
          - slack
          - discord
          - plain
        enabled:
          type: boolean
        report_id:
          type:
          - string
          - 'null'
          format: uuid
    NotificationCreateRequest:
      type: object
      properties:
        name:
          type: string
          maxLength: 200
          description: Defaults to 'Untitled notification'.
        report_id:
          type:
          - string
          - 'null'
          format: uuid
          description: Scope to one report (must be viewable) or null for all.
        webhook_url:
          type: string
          format: uri
          maxLength: 2048
          description: http(s) only.
        signing_secret:
          type:
          - string
          - 'null'
          maxLength: 1024
          description: Enables HMAC-signed deliveries. Encrypted at rest; never returned.
        events:
          type: array
          items:
            type: string
            enum:
            - revision.created
            - comment.created
            - comment.mentioned
            - signoff.submitted
          description: Defaults to all four event types.
        format:
          type: string
          enum:
          - slack
          - discord
          - plain
          default: slack
      required:
      - webhook_url
    Error:
      type: object
      properties:
        error:
          type: string
      required:
      - error
  responses:
    Unauthorized:
      description: Missing, invalid, revoked, or expired token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Deleted:
      description: Deleted.
      content:
        application/json:
          schema:
            type: object
            properties:
              deleted:
                type: boolean
                const: true
            required:
            - deleted
    Forbidden:
      description: Token missing the required scope, or no access to the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: 'Rate limit exceeded. Rate limit: per-token sliding window (plan-aware — Free 60 req/min, Pro 600, Team/Enterprise 6000 by default); 429 responses carry a Retry-After header.'
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found (also returned instead of 403 where existence must not leak).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Malformed body or invalid field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    commaApiToken:
      type: http
      scheme: bearer
      bearerFormat: comma_sk_…
      description: Comma personal API token (Settings → API tokens). Scoped, revocable, optionally expiring. The same token also authenticates the MCP server at /api/mcp.
    supabaseSessionJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Supabase user-session access token — the signed-in browser path. Only accepted where an operation explicitly lists it.
x-refined-from:
- commareports-com-openapi.json
- commareports-com-openapi.yml