Phrase Strings API Reference — Webhooks

naftiko: 1.0.0-alpha2
info:
  label: Phrase Strings API Reference — Webhooks
  description: 'Phrase Strings API Reference — Webhooks. 6 operations. Lead operation: List webhooks. Self-contained Naftiko
    capability covering one Phrase business surface.'
  tags:
  - Phrase
  - Webhooks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PHRASE_API_KEY: PHRASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: strings-webhooks
    baseUri: https://api.phrase.com/v2
    description: Phrase Strings API Reference — Webhooks business capability. Self-contained, no shared references.
    resources:
    - name: projects-project_id-webhooks
      path: /projects/{project_id}/webhooks
      operations:
      - name: webhookslist
        method: GET
        description: List webhooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: webhookcreate
        method: POST
        description: Create a webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-project_id-webhooks-id
      path: /projects/{project_id}/webhooks/{id}
      operations:
      - name: webhookshow
        method: GET
        description: Get a single webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: webhookupdate
        method: PATCH
        description: Update a webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: webhookdelete
        method: DELETE
        description: Delete a webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: projects-project_id-webhooks-id-test
      path: /projects/{project_id}/webhooks/{id}/test
      operations:
      - name: webhooktest
        method: POST
        description: Test a webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.PHRASE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: strings-webhooks-rest
    port: 8080
    description: REST adapter for Phrase Strings API Reference — Webhooks. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects/{project-id}/webhooks
      name: projects-project-id-webhooks
      description: REST surface for projects-project_id-webhooks.
      operations:
      - method: GET
        name: webhookslist
        description: List webhooks
        call: strings-webhooks.webhookslist
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: webhookcreate
        description: Create a webhook
        call: strings-webhooks.webhookcreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/webhooks/{id}
      name: projects-project-id-webhooks-id
      description: REST surface for projects-project_id-webhooks-id.
      operations:
      - method: GET
        name: webhookshow
        description: Get a single webhook
        call: strings-webhooks.webhookshow
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: webhookupdate
        description: Update a webhook
        call: strings-webhooks.webhookupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: webhookdelete
        description: Delete a webhook
        call: strings-webhooks.webhookdelete
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/webhooks/{id}/test
      name: projects-project-id-webhooks-id-test
      description: REST surface for projects-project_id-webhooks-id-test.
      operations:
      - method: POST
        name: webhooktest
        description: Test a webhook
        call: strings-webhooks.webhooktest
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: strings-webhooks-mcp
    port: 9090
    transport: http
    description: MCP adapter for Phrase Strings API Reference — Webhooks. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-webhooks
      description: List webhooks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-webhooks.webhookslist
      outputParameters:
      - type: object
        mapping: $.
    - name: create-webhook
      description: Create a webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: strings-webhooks.webhookcreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-webhook
      description: Get a single webhook
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-webhooks.webhookshow
      outputParameters:
      - type: object
        mapping: $.
    - name: update-webhook
      description: Update a webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: strings-webhooks.webhookupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-webhook
      description: Delete a webhook
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: strings-webhooks.webhookdelete
      outputParameters:
      - type: object
        mapping: $.
    - name: test-webhook
      description: Test a webhook
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: strings-webhooks.webhooktest
      outputParameters:
      - type: object
        mapping: $.