Zeebe REST API — Jobs

naftiko: 1.0.0-alpha2
info:
  label: Zeebe REST API — Jobs
  description: 'Zeebe REST API — Jobs. 5 operations. Lead operation: Zeebe Activate Jobs. Self-contained Naftiko capability
    covering one Zeebe business surface.'
  tags:
  - Zeebe
  - Jobs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZEEBE_API_KEY: ZEEBE_API_KEY
capability:
  consumes:
  - type: http
    namespace: zeebe-jobs
    baseUri: ''
    description: Zeebe REST API — Jobs business capability. Self-contained, no shared references.
    resources:
    - name: jobs-activation
      path: /jobs/activation
      operations:
      - name: activatejobs
        method: POST
        description: Zeebe Activate Jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: jobs-jobKey-completion
      path: /jobs/{jobKey}/completion
      operations:
      - name: completejob
        method: POST
        description: Zeebe Complete a Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobKey
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: jobs-jobKey-error
      path: /jobs/{jobKey}/error
      operations:
      - name: throwerror
        method: POST
        description: Zeebe Throw Error for a Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobKey
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: jobs-jobKey-failure
      path: /jobs/{jobKey}/failure
      operations:
      - name: failjob
        method: POST
        description: Zeebe Fail a Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobKey
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: jobs-jobKey-retries
      path: /jobs/{jobKey}/retries
      operations:
      - name: updatejobretries
        method: PATCH
        description: Zeebe Update Job Retries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobKey
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ZEEBE_API_KEY}}'
  exposes:
  - type: rest
    namespace: zeebe-jobs-rest
    port: 8080
    description: REST adapter for Zeebe REST API — Jobs. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/jobs/activation
      name: jobs-activation
      description: REST surface for jobs-activation.
      operations:
      - method: POST
        name: activatejobs
        description: Zeebe Activate Jobs
        call: zeebe-jobs.activatejobs
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs/{jobkey}/completion
      name: jobs-jobkey-completion
      description: REST surface for jobs-jobKey-completion.
      operations:
      - method: POST
        name: completejob
        description: Zeebe Complete a Job
        call: zeebe-jobs.completejob
        with:
          jobKey: rest.jobKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs/{jobkey}/error
      name: jobs-jobkey-error
      description: REST surface for jobs-jobKey-error.
      operations:
      - method: POST
        name: throwerror
        description: Zeebe Throw Error for a Job
        call: zeebe-jobs.throwerror
        with:
          jobKey: rest.jobKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs/{jobkey}/failure
      name: jobs-jobkey-failure
      description: REST surface for jobs-jobKey-failure.
      operations:
      - method: POST
        name: failjob
        description: Zeebe Fail a Job
        call: zeebe-jobs.failjob
        with:
          jobKey: rest.jobKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs/{jobkey}/retries
      name: jobs-jobkey-retries
      description: REST surface for jobs-jobKey-retries.
      operations:
      - method: PATCH
        name: updatejobretries
        description: Zeebe Update Job Retries
        call: zeebe-jobs.updatejobretries
        with:
          jobKey: rest.jobKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: zeebe-jobs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Zeebe REST API — Jobs. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: zeebe-activate-jobs
      description: Zeebe Activate Jobs
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zeebe-jobs.activatejobs
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: zeebe-complete-job
      description: Zeebe Complete a Job
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zeebe-jobs.completejob
      with:
        jobKey: tools.jobKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: zeebe-throw-error-job
      description: Zeebe Throw Error for a Job
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zeebe-jobs.throwerror
      with:
        jobKey: tools.jobKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: zeebe-fail-job
      description: Zeebe Fail a Job
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zeebe-jobs.failjob
      with:
        jobKey: tools.jobKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: zeebe-update-job-retries
      description: Zeebe Update Job Retries
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: zeebe-jobs.updatejobretries
      with:
        jobKey: tools.jobKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.