Worker Quickstart

Create and start a worker

from pyzeebe import ZeebeWorker


worker = ZeebeWorker()


@worker.task(task_type="my_task")
def my_task(x: int):
    return {"y": x + 1}

worker.work()

Worker connection options

To create a worker with default configuration:

from pyzeebe import ZeebeWorker

worker = ZeebeWorker()  # Will use ZEEBE_ADDRESS environment variable or localhost:26500

To create a worker with custom hostname and port:

worker = ZeebeWorker(hostname="zeebe_gateway", port=26500)

To create a worker with a secure connection:

worker = ZeebeWorker(secure_connection=True)

To create a worker with OAuth 2.0 authentication:

from pyzeebe import ZeebeWorker, OAuthCredentials

credentials = OAuthCredentials(url="oauth_token_url", client_id="client_id", client_secret="client_secret",
                               audience="audience")
worker = ZeebeWorker()

To create a worker for a Camunda Cloud instance:

from pyzeebe import ZeebeWorker, CamundaCloudCredentials

credentials = CamundaCloudCredentials(client_id="client_id", client_secret="client_secret",
                                      cluster_id="cluster_id")
worker = ZeebeWorker()

Add a task

To add a task to the worker:

@worker.task(task_type="my_task")
def my_task(x: int):
    return {"y": x + 1}