zb-client 2.0.0

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package zb-client --version 2.0.0                

                    
                

            
NuGet\Install-Package zb-client -Version 2.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="zb-client" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add zb-client --version 2.0.0                

                    
                

            
#r "nuget: zb-client, 2.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install zb-client as a Cake Addin
#addin nuget:?package=zb-client&version=2.0.0

// Install zb-client as a Cake Tool
#tool nuget:?package=zb-client&version=2.0.0

Build Status alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image Total alerts alternate text is missing from this package README image alternate text is missing from this package README image Compatible with: Camunda Platform 8

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 Compatible and additional computed target framework versions.
.NET 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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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 15,850 9/18/2024
2.6.0 31,395 5/27/2024
2.5.0 48,796 2/2/2024
2.4.0 24,518 12/15/2023
2.3.0 20,398 10/15/2023
2.2.0 73,103 9/8/2023
2.1.0 8,614 8/12/2023
2.0.0 4,368 7/19/2023
1.3.0 259,295 1/19/2023
1.2.1 253,439 2/7/2022
1.2.0 8,421 2/1/2022
1.1.0 57,392 11/10/2021
1.0.2 52,714 8/20/2021
1.0.1 384 8/20/2021
1.0.0 16,518 5/10/2021
0.19.0 19,938 2/28/2021
0.18.0 10,127 9/23/2020
0.17.0 1,947 8/21/2020
0.16.1 11,831 6/4/2020
0.16.0 15,036 4/20/2020
0.15.0 42,581 1/28/2020
0.14.0 823 12/20/2019
0.13.0 758 11/8/2019
0.12.1 1,470 9/6/2019
0.12.0 603 9/6/2019
0.11.0 827 7/16/2019
0.10.0 615 7/10/2019
0.9.0 590 7/8/2019
0.8.0 607 6/11/2019
0.7.0 662 4/5/2019
0.6.0 662 3/14/2019
0.5.0 725 2/14/2019
0.4.0 742 2/6/2019
0.3.0 896 12/14/2018
0.2.0 925 12/9/2018
0.1.0 1,068 6/19/2018

Breaking changes:
     
     This package has been migrated to .net 7.0, since .net core and standard where deprecated. Furthermore, it allowed to migrate to grpc-dotnet,
     which is the official successor of the previous used grpc.core package.

     Another breaking change was the migration to the new deployment resource command, which allows now to deploy DMN additionally to BPMN.
     The interface and the return types have slightly changed.

Features:

     GRPC protocol as generated against Zeebe v8.2.8, which allows to implement further features,
     like evaluation of a decision via command.

-----

This release is based on the Zeebe 8.2.8 release (https://github.com/zeebe-io/zeebe).