https://github.com/camunda-community-hub/zeebe-client-csharp

Contains an Zeebe C# client implementation.
https://github.com/camunda-community-hub/zeebe-client-csharp

camunda-8 camunda-platform-8 csharp grpc-csharp hacktoberfest zb-grcp zeebe zeebe-client

Last synced: 14 days ago
JSON representation

Contains an Zeebe C# client implementation.

• Host: GitHub
• URL: https://github.com/camunda-community-hub/zeebe-client-csharp
• Owner: camunda-community-hub
• License: apache-2.0
• Created: 2018-06-08T12:52:49.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T18:15:41.000Z (6 months ago)
• Last Synced: 2024-05-22T19:35:06.239Z (6 months ago)
• Topics: camunda-8, camunda-platform-8, csharp, grpc-csharp, hacktoberfest, zb-grcp, zeebe, zeebe-client
• Language: C#
• Homepage: https://camunda-community-hub.github.io/zeebe-client-csharp/
• Size: 5.19 MB
• Stars: 89
• Watchers: 10
• Forks: 49
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-camunda-platform-8 - C#

README

        
[![Build Status](https://github.com/camunda-community-hub/zeebe-client-csharp/actions/workflows/aspnetcore.yml/badge.svg)](https://github.com/camunda-community-hub/zeebe-client-csharp/actions/workflows/aspnetcore.yml)

[![](https://img.shields.io/nuget/v/zb-client.svg)](https://www.nuget.org/packages/zb-client/) 

[![](https://img.shields.io/nuget/dt/zb-client)](https://www.nuget.org/stats/packages/zb-client?groupby=Version) 

[![](https://img.shields.io/github/license/zeebe-io/zeebe-client-csharp.svg)](https://www.apache.org/licenses/LICENSE-2.0) 

[![Total alerts](https://img.shields.io/lgtm/alerts/g/zeebe-io/zeebe-client-csharp.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/zeebe-io/zb-csharp-client/alerts/)

[![](https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-FF4700)](https://github.com/camunda-community-hub/community)

[![](https://img.shields.io/badge/Lifecycle-Stable-brightgreen)](https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#stable-)

![Compatible with: Camunda Platform 8](https://img.shields.io/badge/Compatible%20with-Camunda%20Platform%208-0072Ce)

# 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](https://docs.zeebe.io/)

for more information about the Zeebe project.

## Requirements

 * [.net 7.0](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)

 * [Zeebe 8.x release](https://github.com/zeebe-io/zeebe/releases/)*

  _*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](https://camunda-community-hub.github.io/zeebe-client-csharp/).

## 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/](Client.Cloud.Example/).

### Quick start

As quick start you can use the following code:

```csharp

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:

```csharp

var zeebeClient = CamundaCloudClientBuilder

    .Builder()

      .FromEnv()

    .Build();

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

```

## How to build

Run `msbuild Zeebe.sln` or `dotnet build Zeebe.sln`