Freshworks Freshchat API — Conversations

naftiko: 1.0.0-alpha2
info:
  label: Freshworks Freshchat API — Conversations
  description: 'Freshworks Freshchat API — Conversations. 4 operations. Lead operation: List all conversations. 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: freshchat-conversations
    baseUri: https://{domain}.freshchat.com/v2
    description: Freshworks Freshchat API — Conversations business capability. Self-contained, no shared references.
    resources:
    - name: conversations
      path: /conversations
      operations:
      - name: listconversations
        method: GET
        description: List all conversations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter conversations by status (new, assigned, resolved, reopened).
        - name: assigned_agent_id
          in: query
          type: string
          description: Filter by assigned agent ID.
        - name: assigned_group_id
          in: query
          type: string
          description: Filter by assigned group ID.
      - name: createconversation
        method: POST
        description: Create a conversation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: conversations-conversation_id
      path: /conversations/{conversation_id}
      operations:
      - name: getconversation
        method: GET
        description: View a conversation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - 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
    authentication:
      type: bearer
      token: '{{env.FRESHWORKS_API_KEY}}'
  exposes:
  - type: rest
    namespace: freshchat-conversations-rest
    port: 8080
    description: REST adapter for Freshworks Freshchat API — Conversations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/conversations
      name: conversations
      description: REST surface for conversations.
      operations:
      - method: GET
        name: listconversations
        description: List all conversations
        call: freshchat-conversations.listconversations
        with:
          status: rest.status
          assigned_agent_id: rest.assigned_agent_id
          assigned_group_id: rest.assigned_group_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createconversation
        description: Create a conversation
        call: freshchat-conversations.createconversation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/conversations/{conversation-id}
      name: conversations-conversation-id
      description: REST surface for conversations-conversation_id.
      operations:
      - method: GET
        name: getconversation
        description: View a conversation
        call: freshchat-conversations.getconversation
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateconversation
        description: Update a conversation
        call: freshchat-conversations.updateconversation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: freshchat-conversations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshworks Freshchat API — Conversations. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-all-conversations
      description: List all conversations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshchat-conversations.listconversations
      with:
        status: tools.status
        assigned_agent_id: tools.assigned_agent_id
        assigned_group_id: tools.assigned_group_id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-conversation
      description: Create a conversation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: freshchat-conversations.createconversation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-conversation
      description: View a conversation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshchat-conversations.getconversation
      outputParameters:
      - type: object
        mapping: $.
    - name: update-conversation
      description: Update a conversation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: freshchat-conversations.updateconversation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.