Skip to content

camunda-community-hub/zeebe-client-csharp

Folders and files

NameName
Last commit message
Last commit date
Oct 24, 2024
Sep 23, 2024
Nov 12, 2024
Nov 19, 2024
Nov 19, 2024
Nov 12, 2024
Sep 18, 2024
Sep 18, 2024
May 10, 2021
Feb 25, 2021
Sep 21, 2018
May 23, 2024
Feb 24, 2023
Sep 18, 2024
Sep 21, 2018
Dec 10, 2018
Jul 19, 2023
Nov 7, 2019
May 10, 2021
May 11, 2021
Dec 8, 2018
Nov 13, 2024
Sep 2, 2024
Oct 8, 2019
May 11, 2021

Repository files navigation

Build Status Total alerts 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