Freshworks Freshservice API — Conversations

naftiko: 1.0.0-alpha2
info:
  label: Freshworks Freshservice API — Conversations
  description: 'Freshworks Freshservice API — Conversations. 3 operations. Lead operation: List all conversations of a ticket.
    Self-contained Naftiko capability covering one Freshworks business surface.'
  tags:
  - Freshworks
  - Conversations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHWORKS_API_KEY: FRESHWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: freshservice-conversations
    baseUri: https://{domain}.freshservice.com/api/v2
    description: Freshworks Freshservice API — Conversations business capability. Self-contained, no shared references.
    resources:
    - name: tickets-ticket_id-conversations
      path: /tickets/{ticket_id}/conversations
      operations:
      - name: listticketconversations
        method: GET
        description: List all conversations of a ticket
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: tickets-ticket_id-notes
      path: /tickets/{ticket_id}/notes
      operations:
      - name: createnote
        method: POST
        description: Create a note on a ticket
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: tickets-ticket_id-reply
      path: /tickets/{ticket_id}/reply
      operations:
      - name: replytoticket
        method: POST
        description: Reply to a ticket
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.FRESHWORKS_USER}}'
      password: '{{env.FRESHWORKS_PASS}}'
  exposes:
  - type: rest
    namespace: freshservice-conversations-rest
    port: 8080
    description: REST adapter for Freshworks Freshservice API — Conversations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/tickets/{ticket-id}/conversations
      name: tickets-ticket-id-conversations
      description: REST surface for tickets-ticket_id-conversations.
      operations:
      - method: GET
        name: listticketconversations
        description: List all conversations of a ticket
        call: freshservice-conversations.listticketconversations
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tickets/{ticket-id}/notes
      name: tickets-ticket-id-notes
      description: REST surface for tickets-ticket_id-notes.
      operations:
      - method: POST
        name: createnote
        description: Create a note on a ticket
        call: freshservice-conversations.createnote
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tickets/{ticket-id}/reply
      name: tickets-ticket-id-reply
      description: REST surface for tickets-ticket_id-reply.
      operations:
      - method: POST
        name: replytoticket
        description: Reply to a ticket
        call: freshservice-conversations.replytoticket
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: freshservice-conversations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshworks Freshservice API — Conversations. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-all-conversations-ticket
      description: List all conversations of a ticket
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshservice-conversations.listticketconversations
      outputParameters:
      - type: object
        mapping: $.
    - name: create-note-ticket
      description: Create a note on a ticket
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: freshservice-conversations.createnote
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: reply-ticket
      description: Reply to a ticket
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: freshservice-conversations.replytoticket
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.