zb-client

Zeebe C# client

The Zeebe C# client is a C# wrapper implementation around the GRPC (https://github.com/grpc/grpc) generated Zeebe client. It makes it possible to communicate with Zeebe Broker via the GRPC protocol, see the Zeebe documentation for more information about the Zeebe project.

Requirements

• .net 7.0
• Zeebe 8.x release*

*If you use earlier Zeebe versions some commands might be not supported by the Brokers/Gateway and are rejected

How to use

The Zeebe C# client is available via nuget (https://www.nuget.org/packages/zb-client/).

Please have a look at the API documentation.

Camunda Cloud

The Zeebe C# Client is Camunda Cloud ready. To get an example how to use the Zeebe C# Client with the Cloud take a look at Client.Cloud.Example/.

Quick start

As quick start you can use the following code:

var zeebeClient = CamundaCloudClientBuilder
    .Builder()
      .UseClientId("CLIENT_ID")
      .UseClientSecret("CLIENT_SECRET")
      .UseContactPoint("ZEEBE_ADDRESS")
    .Build();

var topology = await zeebeClient.TopologyRequest().Send();

Alternatively you could also read the credentials from the environment:

var zeebeClient = CamundaCloudClientBuilder
    .Builder()
      .FromEnv()
    .Build();

var topology = await zeebeClient.TopologyRequest().Send();

How to build

Run msbuild Zeebe.sln or dotnet build Zeebe.sln