K-φ (K-Phi) Webhooks API

openapi: 3.2.0
info:
  title: K-φ Webhooks API
  version: 1.0.0
  description: 'Read your K-φ data (statements, cash, forecasts, scenarios) and save scenarios. The tenant always comes from the credential. Every response is { data, meta }; every error { error: { code, message } }.'
tags:
- name: Webhooks
paths:
  /api/v1/webhooks:
    get:
      x-audience: data
      x-group: sheets
      operationId: webhooks_list
      summary: 'The webhooks: URL, events, last delivery, failures this week (never the secret)'
      x-scope: read:sheets
      security:
      - bearer: []
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
      tags:
      - Webhooks
    post:
      x-audience: data
      x-group: sheets
      operationId: webhooks_create
      summary: 'Create a webhook: K-φ POSTs sheet.changed, sync.done, sync.failed to your https…'
      description: 'The answer gives the secret once. Each POST carries X-Kphi-Event, X-Kphi-Delivery and X-Kphi-Signature: t=,v1=.">. A non-2xx answer is retried at 1 min, 5 min, 30 min, 2 h and 6 h. Watched sheets are read again every 5 minutes.'
      x-scope: write:sheets
      security:
      - bearer: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                events:
                  type: array
                  items:
                    type: string
                    enum:
                    - sheet.changed
                    - sync.done
                    - sync.failed
                    - var.changed
              required:
              - url
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
        '422':
          description: Not an https URL reachable on the internet, or an unknown event
      tags:
      - Webhooks
  /api/v1/webhooks/{id}:
    delete:
      x-audience: data
      x-group: sheets
      operationId: webhooks_remove
      summary: Remove a webhook and its history
      x-scope: write:sheets
      security:
      - bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
        '404':
          description: No such webhook
      tags:
      - Webhooks
  /api/v1/webhooks/{id}/deliveries:
    get:
      x-audience: data
      x-group: sheets
      operationId: webhooks_deliveries
      summary: What a webhook sent and what came back, a week kept
      x-scope: read:sheets
      security:
      - bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
        '404':
          description: No such webhook
      tags:
      - Webhooks
  /api/v1/webhooks/{id}/test:
    post:
      x-audience: data
      x-group: sheets
      operationId: webhooks_test
      summary: Send a signed ping now and see the answer
      x-scope: write:sheets
      security:
      - bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
        '404':
          description: No such webhook
      tags:
      - Webhooks
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: API key, OAuth access token, extension key (kphix_…) or extension session token (kxs1.…)
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key with the gl:ingest scope (ERP connectors)
x-scopes:
  gl:ingest: Push GL data from an ERP (/api/gl/mappings, /api/gl/schema, /api/gl/ingest)
  mcp:tools: All read scopes (read:gl read:cash read:forecast read:sheets read:data)
  mcp:write: All MCP write scopes (write:scenarios write:config write:data write:sheets)
  read:gl: Read statements, KPIs, ratios, GL lines, versions, dimensions, variance, data lake, FX rates and FP&A settings
  read:cash: Read bank positions, transactions, balance history, cash forecast, AR/AP
  read:forecast: Read forecasts, budgets, scenarios (levers, list, run) and valuations
  read:sheets: Read the Google Sheets registered as inputs of the account, each tab as JSON (/api/v1/sheets/…), and their webhooks' deliveries (2026-11-02)
  write:sheets: 'Register and remove the Google Sheets the account serves as JSON (read only: K-φ never writes to a sheet), and the webhooks told when one changes'
  read:data: 'Read the Data library (/api/v1/data/…): market, macro and public series with their source and licence (2026-11-03)'
  write:vars: 'Define, load and remove the account''s own variables (var.<CODE>) of the Data library, and nothing else: never the books (2026-11-05)'
  write:scenarios: Save scenarios (Simulation page)
  write:config: 'Change tenant configuration: flow rules, classification overrides, budget versions and templates, valuation refresh'
  write:data: 'Import rows from a spreadsheet Claude read (Excel in, 2026-10-29): cash forecasts, a GL version, a bank statement; preview first, then commit'
  run:build: 'Call the BUILD''s functions that only read (POST /api/v1/fn/<name>): the logic the account built, served as an API (2026-10-29)'
  run:build:write: 'Also call the BUILD''s functions that change data (declared "writes": true in its kphi.json)'
x-limits:
  per_ip_per_min: 200
  extension_per_min: 120
  extension_per_day: 20000