Skip to content

Upgrading Spring Boot Job Worker to Camunda 8.7.x

This document is an upgrade guide for consumers who have already set up a Zeebe Job Worker using the Camunda 8.6.x guide. It covers only the changes required to migrate your existing application to Camunda 8.7.x.

If you are setting up a Job Worker from scratch, please refer to the 8.6.x guide first and then apply the changes listed here.


Step 1: Update the Dependency Version

In your pom.xml, bump the spring-boot-starter-camunda-sdk version to 8.7.27 or the latest 8.7.x version available:

<dependency>
    <groupId>io.camunda</groupId>
    <artifactId>spring-boot-starter-camunda-sdk</artifactId>
    <version>8.7.27</version>
</dependency>

Step 2: Update application.yml Configuration

There are two changes in the application.yml configuration for 8.7.x:

# Property (8.6.x) Property (8.7.x) Change
1 camunda.client.tenant-ids (list) camunda.client.tenant-id (single value) Array replaced with a single string value
2 camunda.client.auth.issuer camunda.client.auth.token-url Property renamed

Before (8.6.x)

camunda:
    client:
        mode: self-managed
        tenant-ids:             # ← list
            - {}
        auth:
            client-id: zeebe
            client-secret: xxxxxxxxx
            issuer: https://optima-dev.optumrx.com/auth/realms/optima-xxxx/protocol/openid-connect/token  # ← issuer
        zeebe:
            enabled: true
            grpc-address: https://zeebe-optima-xxxxx.optumrx.com
            ca-certificate-path: certificates/rootchain.pem
            audience: zeebe-api
            execution-threads: 3
            keep-alive: PT60S
            request-timeout: PT10S

After (8.7.x)

camunda:
    client:
        mode: self-managed
        tenant-id: {}    # ← single value (not a list)
        auth:
            client-id: zeebe
            client-secret: xxxxxxxxx
            token-url: https://optima-dev.optumrx.com/auth/realms/optima-xxxx/protocol/openid-connect/token  # ← renamed from issuer
        zeebe:
            enabled: true
            grpc-address: https://zeebe-optima-xxxxx.optumrx.com
            ca-certificate-path: certificates/rootchain.pem
            audience: zeebe-api
            execution-threads: 3
            keep-alive: PT60S
            request-timeout: PT10S

ℹ️ All other configuration properties remain unchanged.


No Other Code Changes Required

Your existing @JobWorker implementations, variable handling, and all other application code remain fully compatible with 8.7.x. Only the two configuration changes above are required.