Client QuickStart¶
Create a client¶
To create a client with default configuration:
from pyzeebe import ZeebeClient
client = ZeebeClient() # Will use ZEEBE_ADDRESS environment variable or localhost:26500
To create a client with custom hostname and port:
client = ZeebeClient(hostname="zeebe_gateway", port=26500)
To create a client with a secure connection:
client = ZeebeClient(secure_connection=True)
To create a client with OAuth 2.0 authentication:
from pyzeebe import ZeebeClient, OAuthCredentials
credentials = OAuthCredentials(url="oauth_token_url", client_id="client_id", client_secret="client_secret",
audience="audience")
client = ZeebeClient()
To create a client for a Camunda Cloud instance:
from pyzeebe import ZeebeClient, CamundaCloudCredentials
credentials = CamundaCloudCredentials(client_id="client_id", client_secret="client_secret",
cluster_id="cluster_id")
client = ZeebeClient()
Run a workflow¶
workflow_instance_key = client.run_workflow("bpmn_process_id")
Run a workflow with result¶
To run a workflow and receive the result directly:
result = client.run_workflow_with_result("bpmn_process_id")
# result will be a dict
Deploy a workflow¶
client.deploy_workflow("workflow_file.bpmn")
Publish a message¶
client.publish_message(name="message_name", correlation_key="correlation_key")