Follow this link for the Zeebe gRPC Gateway Protocol Documentation.
This library provides:
-
a ready to use grpc-js client for the Zeebe Gateway Protocol
-
Typescript type definitions for requests and responses including JSON transformers
-
JSON Schemas for all requests and responses objects
npm i --save @hauptmedia/zeebe-gateway-types| Message Type | Docs | JSON Schema |
|---|---|---|
| ActivateJobsRequest | docs | JSON Schema |
| ActivateJobsResponse | docs | JSON Schema |
| CancelProcessInstanceRequest | docs | JSON Schema |
| CancelProcessInstanceResponse | docs | JSON Schema |
| CompleteJobRequest | docs | JSON Schema |
| CompleteJobResponse | docs | JSON Schema |
| CreateProcessInstanceRequest | docs | JSON Schema |
| CreateProcessInstanceResponse | docs | JSON Schema |
| CreateProcessInstanceWithResultRequest | docs | JSON Schema |
| CreateProcessInstanceWithResultResponse | docs | JSON Schema |
| DeployResourceRequest | docs | JSON Schema |
| DeployResourceResponse | docs | JSON Schema |
| FailJobRequest | docs | JSON Schema |
| FailJobResponse | docs | JSON Schema |
| ModifyProcessInstanceRequest | docs | JSON Schema |
| ModifyProcessInstanceResponse | docs | JSON Schema |
| PublishMessageRequest | docs | JSON Schema |
| PublishMessageResponse | docs | JSON Schema |
| ResolveIncidentRequest | docs | JSON Schema |
| ResolveIncidentResponse | docs | JSON Schema |
| SetVariablesRequest | docs | JSON Schema |
| SetVariablesResponse | docs | JSON Schema |
| ThrowErrorRequest | docs | JSON Schema |
| ThrowErrorResponse | docs | JSON Schema |
| TopologyRequest | docs | JSON Schema |
| TopologyResponse | docs | JSON Schema |
| UpdateJobRetriesRequest | docs | JSON Schema |
| UpdateJobRetriesResponse | docs | JSON Schema |
import {GatewayClient, DeployResourceRequest} from "@hauptmedia/zeebe-gateway-types";
import {ChannelCredentials} from "@grpc/grpc-js";
const zbc = new GatewayClient("localhost:26500", ChannelCredentials.createInsecure());
const req = DeployResourceRequest.fromJSON({
"resources": [
{
"name": "test.bpmn",
"content": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPGJwbW46ZGVmaW5pdGlvbnMgeG1sbnM6YnBtbj0iaHR0cDovL3d3dy5vbWcub3JnL3NwZWMvQlBNTi8yMDEwMDUyNC9NT0RFTCIgeG1sbnM6YnBtbmRpPSJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9CUE1OLzIwMTAwNTI0L0RJIiB4bWxuczpkYz0iaHR0cDovL3d3dy5vbWcub3JnL3NwZWMvREQvMjAxMDA1MjQvREMiIHhtbG5zOmRpPSJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9ERC8yMDEwMDUyNC9ESSIgeG1sbnM6bW9kZWxlcj0iaHR0cDovL2NhbXVuZGEub3JnL3NjaGVtYS9tb2RlbGVyLzEuMCIgaWQ9IkRlZmluaXRpb25zXzF3cXR5eWkiIHRhcmdldE5hbWVzcGFjZT0iaHR0cDovL2JwbW4uaW8vc2NoZW1hL2JwbW4iIGV4cG9ydGVyPSJDYW11bmRhIE1vZGVsZXIiIGV4cG9ydGVyVmVyc2lvbj0iNS40LjEiIG1vZGVsZXI6ZXhlY3V0aW9uUGxhdGZvcm09IkNhbXVuZGEgQ2xvdWQiIG1vZGVsZXI6ZXhlY3V0aW9uUGxhdGZvcm1WZXJzaW9uPSI4LjEuMCI+CjxicG1uOnByb2Nlc3MgaWQ9IlByb2Nlc3NfMTF6bG5lZyIgaXNFeGVjdXRhYmxlPSJ0cnVlIj4KPGJwbW46c3RhcnRFdmVudCBpZD0iU3RhcnRFdmVudF8xIj4KPGJwbW46b3V0Z29pbmc+Rmxvd18wanQ4bHUzPC9icG1uOm91dGdvaW5nPgo8L2JwbW46c3RhcnRFdmVudD4KPGJwbW46ZW5kRXZlbnQgaWQ9IkV2ZW50XzE3anp2eGwiPgo8YnBtbjppbmNvbWluZz5GbG93XzBqdDhsdTM8L2JwbW46aW5jb21pbmc+CjwvYnBtbjplbmRFdmVudD4KPGJwbW46c2VxdWVuY2VGbG93IGlkPSJGbG93XzBqdDhsdTMiIHNvdXJjZVJlZj0iU3RhcnRFdmVudF8xIiB0YXJnZXRSZWY9IkV2ZW50XzE3anp2eGwiIC8+CjwvYnBtbjpwcm9jZXNzPgo8YnBtbmRpOkJQTU5EaWFncmFtIGlkPSJCUE1ORGlhZ3JhbV8xIj4KPGJwbW5kaTpCUE1OUGxhbmUgaWQ9IkJQTU5QbGFuZV8xIiBicG1uRWxlbWVudD0iUHJvY2Vzc18xMXpsbmVnIj4KPGJwbW5kaTpCUE1OU2hhcGUgaWQ9Il9CUE1OU2hhcGVfU3RhcnRFdmVudF8yIiBicG1uRWxlbWVudD0iU3RhcnRFdmVudF8xIj4KPGRjOkJvdW5kcyB4PSIxNzkiIHk9Ijc5IiB3aWR0aD0iMzYiIGhlaWdodD0iMzYiIC8+CjwvYnBtbmRpOkJQTU5TaGFwZT4KPGJwbW5kaTpCUE1OU2hhcGUgaWQ9IkV2ZW50XzE3anp2eGxfZGkiIGJwbW5FbGVtZW50PSJFdmVudF8xN2p6dnhsIj4KPGRjOkJvdW5kcyB4PSIyOTIiIHk9Ijc5IiB3aWR0aD0iMzYiIGhlaWdodD0iMzYiIC8+CjwvYnBtbmRpOkJQTU5TaGFwZT4KPGJwbW5kaTpCUE1ORWRnZSBpZD0iRmxvd18wanQ4bHUzX2RpIiBicG1uRWxlbWVudD0iRmxvd18wanQ4bHUzIj4KPGRpOndheXBvaW50IHg9IjIxNSIgeT0iOTciIC8+CjxkaTp3YXlwb2ludCB4PSIyOTIiIHk9Ijk3IiAvPgo8L2JwbW5kaTpCUE1ORWRnZT4KPC9icG1uZGk6QlBNTlBsYW5lPgo8L2JwbW5kaTpCUE1ORGlhZ3JhbT4KPC9icG1uOmRlZmluaXRpb25zPg=="
}
]
});
zbc.deployResource(req, (error, response) => {
if (error)
throw error;
else
console.log(response);
});
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent