Zendesk Support API — Tickets

naftiko: 1.0.0-alpha2
info:
  label: Zendesk Support API — Tickets
  description: 'Zendesk Support API — Tickets. 6 operations. Lead operation: Zendesk List Tickets. Self-contained Naftiko
    capability covering one Zendesk business surface.'
  tags:
  - Zendesk
  - Tickets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZENDESK_API_KEY: ZENDESK_API_KEY
capability:
  consumes:
  - type: http
    namespace: support-tickets
    baseUri: https://{subdomain}.zendesk.com/api/v2
    description: Zendesk Support API — Tickets business capability. Self-contained, no shared references.
    resources:
    - name: tickets
      path: /tickets
      operations:
      - name: listtickets
        method: GET
        description: Zendesk List Tickets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sort_by
          in: query
          type: string
          description: The field to sort tickets by.
        - name: sort_order
          in: query
          type: string
          description: The sort order.
        - name: external_id
          in: query
          type: string
          description: Filter tickets by external ID.
      - name: createticket
        method: POST
        description: Zendesk Create 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
      path: /tickets/{ticket_id}
      operations:
      - name: getticket
        method: GET
        description: Zendesk Show Ticket
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateticket
        method: PUT
        description: Zendesk Update Ticket
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteticket
        method: DELETE
        description: Zendesk Delete Ticket
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: tickets-ticket_id-comments
      path: /tickets/{ticket_id}/comments
      operations:
      - name: listticketcomments
        method: GET
        description: Zendesk List Ticket Comments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sort_order
          in: query
          type: string
          description: Sort order for comments.
    authentication:
      type: bearer
      token: '{{env.ZENDESK_API_KEY}}'
  exposes:
  - type: rest
    namespace: support-tickets-rest
    port: 8080
    description: REST adapter for Zendesk Support API — Tickets. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/tickets
      name: tickets
      description: REST surface for tickets.
      operations:
      - method: GET
        name: listtickets
        description: Zendesk List Tickets
        call: support-tickets.listtickets
        with:
          sort_by: rest.sort_by
          sort_order: rest.sort_order
          external_id: rest.external_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createticket
        description: Zendesk Create Ticket
        call: support-tickets.createticket
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tickets/{ticket-id}
      name: tickets-ticket-id
      description: REST surface for tickets-ticket_id.
      operations:
      - method: GET
        name: getticket
        description: Zendesk Show Ticket
        call: support-tickets.getticket
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateticket
        description: Zendesk Update Ticket
        call: support-tickets.updateticket
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteticket
        description: Zendesk Delete Ticket
        call: support-tickets.deleteticket
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tickets/{ticket-id}/comments
      name: tickets-ticket-id-comments
      description: REST surface for tickets-ticket_id-comments.
      operations:
      - method: GET
        name: listticketcomments
        description: Zendesk List Ticket Comments
        call: support-tickets.listticketcomments
        with:
          sort_order: rest.sort_order
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: support-tickets-mcp
    port: 9090
    transport: http
    description: MCP adapter for Zendesk Support API — Tickets. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: zendesk-list-tickets
      description: Zendesk List Tickets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: support-tickets.listtickets
      with:
        sort_by: tools.sort_by
        sort_order: tools.sort_order
        external_id: tools.external_id
      outputParameters:
      - type: object
        mapping: $.
    - name: zendesk-create-ticket
      description: Zendesk Create Ticket
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: support-tickets.createticket
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: zendesk-show-ticket
      description: Zendesk Show Ticket
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: support-tickets.getticket
      outputParameters:
      - type: object
        mapping: $.
    - name: zendesk-update-ticket
      description: Zendesk Update Ticket
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: support-tickets.updateticket
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: zendesk-delete-ticket
      description: Zendesk Delete Ticket
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: support-tickets.deleteticket
      outputParameters:
      - type: object
        mapping: $.
    - name: zendesk-list-ticket-comments
      description: Zendesk List Ticket Comments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: support-tickets.listticketcomments
      with:
        sort_order: tools.sort_order
      outputParameters:
      - type: object
        mapping: $.