API Reference — subpackage_webhooks

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_webhooks
  description: 'API Reference — subpackage_webhooks. 6 operations. Lead operation: List all webhooks. Self-contained Naftiko
    capability covering one Label Studio business surface.'
  tags:
  - Label Studio
  - subpackage_webhooks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LABEL_STUDIO_API_KEY: LABEL_STUDIO_API_KEY
capability:
  consumes:
  - type: http
    namespace: label-studio-subpackage-webhooks
    baseUri: http://localhost:8000
    description: API Reference — subpackage_webhooks business capability. Self-contained, no shared references.
    resources:
    - name: api-webhooks
      path: /api/webhooks/
      operations:
      - name: list
        method: GET
        description: List all webhooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: project
          in: query
          type: string
          description: Project ID
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: create
        method: POST
        description: Create a webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-webhooks-info
      path: /api/webhooks/info/
      operations:
      - name: info
        method: GET
        description: Get all webhook actions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization-only
          in: query
          type: boolean
          description: organization-only or not
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
    - name: api-webhooks-id
      path: /api/webhooks/{id}/
      operations:
      - name: get
        method: GET
        description: Get webhook info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: delete
        method: DELETE
        description: Delete webhook info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: update
        method: PATCH
        description: Update webhook info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.LABEL_STUDIO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: label-studio-subpackage-webhooks-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_webhooks. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/webhooks
      name: api-webhooks
      description: REST surface for api-webhooks.
      operations:
      - method: GET
        name: list
        description: List all webhooks
        call: label-studio-subpackage-webhooks.list
        with:
          project: rest.project
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create a webhook
        call: label-studio-subpackage-webhooks.create
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/webhooks/info
      name: api-webhooks-info
      description: REST surface for api-webhooks-info.
      operations:
      - method: GET
        name: info
        description: Get all webhook actions
        call: label-studio-subpackage-webhooks.info
        with:
          organization-only: rest.organization-only
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/webhooks/{id}
      name: api-webhooks-id
      description: REST surface for api-webhooks-id.
      operations:
      - method: GET
        name: get
        description: Get webhook info
        call: label-studio-subpackage-webhooks.get
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete webhook info
        call: label-studio-subpackage-webhooks.delete
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: update
        description: Update webhook info
        call: label-studio-subpackage-webhooks.update
        with:
          id: rest.id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: label-studio-subpackage-webhooks-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_webhooks. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-webhooks
      description: List all webhooks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-webhooks.list
      with:
        project: tools.project
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-webhook
      description: Create a webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-webhooks.create
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-webhook-actions
      description: Get all webhook actions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-webhooks.info
      with:
        organization-only: tools.organization-only
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-webhook-info
      description: Get webhook info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-webhooks.get
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-webhook-info
      description: Delete webhook info
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio-subpackage-webhooks.delete
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-webhook-info
      description: Update webhook info
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: label-studio-subpackage-webhooks.update
      with:
        id: tools.id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.