zb-client
2.7.0
dotnet add package zb-client --version 2.7.0
NuGet\Install-Package zb-client -Version 2.7.0
<PackageReference Include="zb-client" Version="2.7.0" />
paket add zb-client --version 2.7.0
#r "nuget: zb-client, 2.7.0"
// Install zb-client as a Cake Addin #addin nuget:?package=zb-client&version=2.7.0 // Install zb-client as a Cake Tool #tool nuget:?package=zb-client&version=2.7.0
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
*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
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- Google.Protobuf (>= 3.28.1)
- Grpc (>= 2.46.6)
- Grpc.Auth (>= 2.63.0)
- Grpc.Net.Client (>= 2.63.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
-
net7.0
- Google.Protobuf (>= 3.28.1)
- Grpc (>= 2.46.6)
- Grpc.Auth (>= 2.63.0)
- Grpc.Net.Client (>= 2.63.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
-
net8.0
- Google.Protobuf (>= 3.28.1)
- Grpc (>= 2.46.6)
- Grpc.Auth (>= 2.63.0)
- Grpc.Net.Client (>= 2.63.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on zb-client:
Package | Downloads |
---|---|
zb-client-bootstrap
This project is an extension of the zb-client (https://www.nuget.org/packages/zb-client/). Zeebe Job handlers are automaticly recognized and boostrapped via a .Net HostedService. For more information about the zeebe project please visit https://camunda.com/platform/zeebe/ |
|
zb-client-accelerator
This project is an extension of the zb-client (https://www.nuget.org/packages/zb-client/). Zeebe Job Workers are automatically recognized and boostrapped via a .Net HostedService. For more information about the zeebe project please visit https://camunda.com/platform/zeebe/ The basic idea for this came from https://github.com/camunda-community-hub/zeebe-client-csharp-bootstrap. We loved the idea, but had in some parts our own preferences for defaults, behaviour and separation of concerns. So this is our version of a good Bootstrap Extension for the C# Zeebe Client. Credits still belong to https://github.com/arjangeertsema. |
|
ZeeBridge
Simplify your Camunda integration with ZeeBridge, a .NET library designed to bridge the gap between worker jobs in your source code and Camunda. With its easy-to-use API and Zeebe-powered communication, ZeeBridge is the perfect solution for your Camunda connection needs. |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on zb-client:
Repository | Stars |
---|---|
camunda-community-hub/zeebe-client-csharp
Contains an Zeebe C# client implementation.
|
Version | Downloads | Last updated |
---|---|---|
2.7.0 | 17,387 | 9/18/2024 |
2.6.0 | 31,922 | 5/27/2024 |
2.5.0 | 48,885 | 2/2/2024 |
2.4.0 | 24,577 | 12/15/2023 |
2.3.0 | 20,518 | 10/15/2023 |
2.2.0 | 75,170 | 9/8/2023 |
2.1.0 | 8,616 | 8/12/2023 |
2.0.0 | 4,369 | 7/19/2023 |
1.3.0 | 260,851 | 1/19/2023 |
1.2.1 | 253,762 | 2/7/2022 |
1.2.0 | 8,421 | 2/1/2022 |
1.1.0 | 57,544 | 11/10/2021 |
1.0.2 | 52,723 | 8/20/2021 |
1.0.1 | 384 | 8/20/2021 |
1.0.0 | 16,549 | 5/10/2021 |
0.19.0 | 20,189 | 2/28/2021 |
0.18.0 | 10,145 | 9/23/2020 |
0.17.0 | 1,947 | 8/21/2020 |
0.16.1 | 11,840 | 6/4/2020 |
0.16.0 | 15,044 | 4/20/2020 |
0.15.0 | 42,583 | 1/28/2020 |
0.14.0 | 825 | 12/20/2019 |
0.13.0 | 760 | 11/8/2019 |
0.12.1 | 1,472 | 9/6/2019 |
0.12.0 | 605 | 9/6/2019 |
0.11.0 | 828 | 7/16/2019 |
0.10.0 | 617 | 7/10/2019 |
0.9.0 | 592 | 7/8/2019 |
0.8.0 | 609 | 6/11/2019 |
0.7.0 | 664 | 4/5/2019 |
0.6.0 | 663 | 3/14/2019 |
0.5.0 | 727 | 2/14/2019 |
0.4.0 | 744 | 2/6/2019 |
0.3.0 | 900 | 12/14/2018 |
0.2.0 | 929 | 12/9/2018 |
0.1.0 | 1,072 | 6/19/2018 |
See release notes https://github.com/camunda-community-hub/zeebe-client-csharp/releases
This release is based on the Zeebe 8.5.6 release (https://github.com/zeebe-io/zeebe).