naftiko: 1.0.0-alpha2
info:
  label: "Ashby \u2014 Custom Fields"
  description: Ashby Custom Fields capability. Define and update custom fields and set values across entities.
  tags:
  - Ashby
  - Recruiting
  - ATS
  - Custom Fields
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    ASHBY_API_KEY: ASHBY_API_KEY
capability:
  consumes:
  - type: http
    namespace: custom-fields-custom-fields
    baseUri: https://api.ashbyhq.com
    description: Ashby Custom Fields capability. Define and update custom fields and set values across entities. Backed by the Ashby public REST API.
    resources:
    - name: custom-field-list
      path: /customField.list
      operations:
      - name: custom-field-list
        method: POST
        description: List custom fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON). See https://developers.ashbyhq.com/reference for the schema of each operation.
          required: false
        headers:
        - name: Accept
          value: application/json; version=1
        - name: Content-Type
          value: application/json
    - name: custom-field-create
      path: /customField.create
      operations:
      - name: custom-field-create
        method: POST
        description: Create a custom field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON). See https://developers.ashbyhq.com/reference for the schema of each operation.
          required: false
        headers:
        - name: Accept
          value: application/json; version=1
        - name: Content-Type
          value: application/json
    - name: custom-field-info
      path: /customField.info
      operations:
      - name: custom-field-info
        method: POST
        description: Get custom field info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON). See https://developers.ashbyhq.com/reference for the schema of each operation.
          required: false
        headers:
        - name: Accept
          value: application/json; version=1
        - name: Content-Type
          value: application/json
    - name: custom-field-set-value
      path: /customField.setValue
      operations:
      - name: custom-field-set-value
        method: POST
        description: Set a custom field value on an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON). See https://developers.ashbyhq.com/reference for the schema of each operation.
          required: false
        headers:
        - name: Accept
          value: application/json; version=1
        - name: Content-Type
          value: application/json
    - name: custom-field-set-values
      path: /customField.setValues
      operations:
      - name: custom-field-set-values
        method: POST
        description: Batch-set custom field values
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON). See https://developers.ashbyhq.com/reference for the schema of each operation.
          required: false
        headers:
        - name: Accept
          value: application/json; version=1
        - name: Content-Type
          value: application/json
    - name: custom-field-update-selectable-values
      path: /customField.updateSelectableValues
      operations:
      - name: custom-field-update-selectable-values
        method: POST
        description: Update selectable values for a select custom field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON). See https://developers.ashbyhq.com/reference for the schema of each operation.
          required: false
        headers:
        - name: Accept
          value: application/json; version=1
        - name: Content-Type
          value: application/json
    authentication:
      type: basic
      username: '{{env.ASHBY_API_KEY}}'
      password: ''
      description: 'HTTP Basic Auth: Ashby API key as username, blank password.'
  exposes:
  - type: rest
    namespace: custom-fields-custom-fields-rest
    port: 8080
    description: "REST adapter for Ashby \u2014 Custom Fields. One Spectral-compliant resource per consumed operation, prefixed with /v1."
    resources:
    - path: /v1/customField.list
      name: custom-field-list
      description: REST surface for custom-field-list.
      operations:
      - method: POST
        name: custom-field-list
        description: List custom fields
        call: custom-fields-custom-fields.custom-field-list
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/customField.create
      name: custom-field-create
      description: REST surface for custom-field-create.
      operations:
      - method: POST
        name: custom-field-create
        description: Create a custom field
        call: custom-fields-custom-fields.custom-field-create
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/customField.info
      name: custom-field-info
      description: REST surface for custom-field-info.
      operations:
      - method: POST
        name: custom-field-info
        description: Get custom field info
        call: custom-fields-custom-fields.custom-field-info
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/customField.setValue
      name: custom-field-set-value
      description: REST surface for custom-field-set-value.
      operations:
      - method: POST
        name: custom-field-set-value
        description: Set a custom field value on an entity
        call: custom-fields-custom-fields.custom-field-set-value
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/customField.setValues
      name: custom-field-set-values
      description: REST surface for custom-field-set-values.
      operations:
      - method: POST
        name: custom-field-set-values
        description: Batch-set custom field values
        call: custom-fields-custom-fields.custom-field-set-values
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/customField.updateSelectableValues
      name: custom-field-update-selectable-values
      description: REST surface for custom-field-update-selectable-values.
      operations:
      - method: POST
        name: custom-field-update-selectable-values
        description: Update selectable values for a select custom field
        call: custom-fields-custom-fields.custom-field-update-selectable-values
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: custom-fields-custom-fields-mcp
    port: 9090
    transport: http
    description: "MCP adapter for Ashby \u2014 Custom Fields. One tool per consumed operation, routed inline through this capability's consumes block."
    tools:
    - name: ashby-custom-field-list
      description: List custom fields
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: custom-fields-custom-fields.custom-field-list
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ashby-custom-field-create
      description: Create a custom field
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: custom-fields-custom-fields.custom-field-create
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ashby-custom-field-info
      description: Get custom field info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: custom-fields-custom-fields.custom-field-info
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ashby-custom-field-set-value
      description: Set a custom field value on an entity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: custom-fields-custom-fields.custom-field-set-value
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ashby-custom-field-set-values
      description: Batch-set custom field values
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: custom-fields-custom-fields.custom-field-set-values
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ashby-custom-field-update-selectable-values
      description: Update selectable values for a select custom field
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: custom-fields-custom-fields.custom-field-update-selectable-values
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.