Whatfix API — End Users

naftiko: 1.0.0-alpha2
info:
  label: Whatfix API — End Users
  description: 'Whatfix API — End Users. 2 operations. Lead operation: List End Users. Self-contained Naftiko capability covering
    one Whatfix business surface.'
  tags:
  - Whatfix
  - End Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WHATFIX_API_KEY: WHATFIX_API_KEY
capability:
  consumes:
  - type: http
    namespace: whatfix-end-users
    baseUri: https://whatfix.com/api/v1
    description: Whatfix API — End Users business capability. Self-contained, no shared references.
    resources:
    - name: accountId-end-users
      path: /{accountId}/end-users
      operations:
      - name: listendusers
        method: GET
        description: List End Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-end-users-userId
      path: /{accountId}/end-users/{userId}
      operations:
      - name: upsertenduser
        method: PUT
        description: Upsert End User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: Unique identifier for the end user.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: x-whatfix-integration-key
      value: '{{env.WHATFIX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: whatfix-end-users-rest
    port: 8080
    description: REST adapter for Whatfix API — End Users. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/{accountid}/end-users
      name: accountid-end-users
      description: REST surface for accountId-end-users.
      operations:
      - method: GET
        name: listendusers
        description: List End Users
        call: whatfix-end-users.listendusers
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/{accountid}/end-users/{userid}
      name: accountid-end-users-userid
      description: REST surface for accountId-end-users-userId.
      operations:
      - method: PUT
        name: upsertenduser
        description: Upsert End User
        call: whatfix-end-users.upsertenduser
        with:
          userId: rest.userId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: whatfix-end-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Whatfix API — End Users. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-end-users
      description: List End Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: whatfix-end-users.listendusers
      outputParameters:
      - type: object
        mapping: $.
    - name: upsert-end-user
      description: Upsert End User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: whatfix-end-users.upsertenduser
      with:
        userId: tools.userId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.