Freshdesk REST API — Conversations

naftiko: 1.0.0-alpha2
info:
  label: Freshdesk REST API — Conversations
  description: 'Freshdesk REST API — Conversations. 6 operations. Lead operation: Update a conversation. Self-contained Naftiko
    capability covering one Freshdesk business surface.'
  tags:
  - Freshdesk
  - Conversations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHDESK_API_KEY: FRESHDESK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-conversations
    baseUri: https://{domain}.freshdesk.com/api/v2
    description: Freshdesk REST API — Conversations business capability. Self-contained, no shared references.
    resources:
    - name: conversations-conversation_id
      path: /conversations/{conversation_id}
      operations:
      - name: updateconversation
        method: PUT
        description: Update a conversation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteconversation
        method: DELETE
        description: Delete a conversation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: tickets-ticket_id-conversations
      path: /tickets/{ticket_id}/conversations
      operations:
      - name: listticketconversations
        method: GET
        description: List conversations on a ticket
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: tickets-ticket_id-forward
      path: /tickets/{ticket_id}/forward
      operations:
      - name: forwardticket
        method: POST
        description: Forward 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-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.FRESHDESK_USER}}'
      password: '{{env.FRESHDESK_PASS}}'
  exposes:
  - type: rest
    namespace: rest-conversations-rest
    port: 8080
    description: REST adapter for Freshdesk REST API — Conversations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/conversations/{conversation-id}
      name: conversations-conversation-id
      description: REST surface for conversations-conversation_id.
      operations:
      - method: PUT
        name: updateconversation
        description: Update a conversation
        call: rest-conversations.updateconversation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconversation
        description: Delete a conversation
        call: rest-conversations.deleteconversation
        outputParameters:
        - type: object
          mapping: $.
    - 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 conversations on a ticket
        call: rest-conversations.listticketconversations
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tickets/{ticket-id}/forward
      name: tickets-ticket-id-forward
      description: REST surface for tickets-ticket_id-forward.
      operations:
      - method: POST
        name: forwardticket
        description: Forward a ticket
        call: rest-conversations.forwardticket
        with:
          body: rest.body
        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: rest-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: rest-conversations.replytoticket
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-conversations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshdesk REST API — Conversations. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: update-conversation
      description: Update a conversation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-conversations.updateconversation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-conversation
      description: Delete a conversation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-conversations.deleteconversation
      outputParameters:
      - type: object
        mapping: $.
    - name: list-conversations-ticket
      description: List conversations on a ticket
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-conversations.listticketconversations
      outputParameters:
      - type: object
        mapping: $.
    - name: forward-ticket
      description: Forward a ticket
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-conversations.forwardticket
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-note-ticket
      description: Create a note on a ticket
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-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: rest-conversations.replytoticket
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.