HubSpot Conversations API — Inboxes

naftiko: 1.0.0-alpha2
info:
  label: HubSpot Conversations API — Inboxes
  description: 'HubSpot Conversations API — Inboxes. 2 operations. Lead operation: Hubspot List All Inboxes. Self-contained
    Naftiko capability covering one Hubspot business surface.'
  tags:
  - Hubspot
  - Inboxes
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUBSPOT_API_KEY: HUBSPOT_API_KEY
capability:
  consumes:
  - type: http
    namespace: conversations-inboxes
    baseUri: https://api.hubapi.com
    description: HubSpot Conversations API — Inboxes business capability. Self-contained, no shared references.
    resources:
    - name: conversations-v3-conversations-inboxes
      path: /conversations/v3/conversations/inboxes
      operations:
      - name: listinboxes
        method: GET
        description: Hubspot List All Inboxes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of results per page (1-100)
        - name: after
          in: query
          type: string
          description: Pagination cursor for retrieving the next page of results
        - name: sort
          in: query
          type: string
          description: Property name to sort results by
        - name: archived
          in: query
          type: boolean
          description: Set to true to include archived inboxes in results
    - name: conversations-v3-conversations-inboxes-inboxId
      path: /conversations/v3/conversations/inboxes/{inboxId}
      operations:
      - name: getinboxbyid
        method: GET
        description: Hubspot Retrieve an Inbox
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inboxId
          in: path
          type: string
          description: The unique identifier of the inbox to retrieve
          required: true
    authentication:
      type: bearer
      token: '{{env.HUBSPOT_API_KEY}}'
  exposes:
  - type: rest
    namespace: conversations-inboxes-rest
    port: 8080
    description: REST adapter for HubSpot Conversations API — Inboxes. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/conversations/v3/conversations/inboxes
      name: conversations-v3-conversations-inboxes
      description: REST surface for conversations-v3-conversations-inboxes.
      operations:
      - method: GET
        name: listinboxes
        description: Hubspot List All Inboxes
        call: conversations-inboxes.listinboxes
        with:
          limit: rest.limit
          after: rest.after
          sort: rest.sort
          archived: rest.archived
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/conversations/v3/conversations/inboxes/{inboxid}
      name: conversations-v3-conversations-inboxes-inboxid
      description: REST surface for conversations-v3-conversations-inboxes-inboxId.
      operations:
      - method: GET
        name: getinboxbyid
        description: Hubspot Retrieve an Inbox
        call: conversations-inboxes.getinboxbyid
        with:
          inboxId: rest.inboxId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: conversations-inboxes-mcp
    port: 9090
    transport: http
    description: MCP adapter for HubSpot Conversations API — Inboxes. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: hubspot-list-all-inboxes
      description: Hubspot List All Inboxes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: conversations-inboxes.listinboxes
      with:
        limit: tools.limit
        after: tools.after
        sort: tools.sort
        archived: tools.archived
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-retrieve-inbox
      description: Hubspot Retrieve an Inbox
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: conversations-inboxes.getinboxbyid
      with:
        inboxId: tools.inboxId
      outputParameters:
      - type: object
        mapping: $.