README.md

Zeebe Cloudevents Gateway

Maps Zeebe Commands and Events to Cloudevents.io compatible HTTP Endpoints.

Zeebe Cloudevents Commands

This Cloudevents gateway consumes the following Cloudevents via the integrated http listener. Any Cloudevent with a request type produces the corresponding response Cloudevent on the originating channel (e.g. as HTTP response). This is basically a thin translation layer for the Zeebe gRPC gateway protocol.

Cloudevent Type	Json Schema
io.zeebe.command.v1.ActivateJobsRequest	JSON Schema
io.zeebe.command.v1.ActivateJobsResponse	JSON Schema
io.zeebe.command.v1.CancelProcessInstanceRequest	JSON Schema
io.zeebe.command.v1.CancelProcessInstanceResponse	JSON Schema
io.zeebe.command.v1.CompleteJobRequest	JSON Schema
io.zeebe.command.v1.CompleteJobResponse	JSON Schema
io.zeebe.command.v1.CreateProcessInstanceRequest	JSON Schema
io.zeebe.command.v1.CreateProcessInstanceResponse	JSON Schema
io.zeebe.command.v1.CreateProcessInstanceWithResultRequest	JSON Schema
io.zeebe.command.v1.CreateProcessInstanceWithResultResponse	JSON Schema
io.zeebe.command.v1.DeployResourceRequest	JSON Schema
io.zeebe.command.v1.DeployResourceResponse	JSON Schema
io.zeebe.command.v1.FailJobRequest	JSON Schema
io.zeebe.command.v1.FailJobResponse	JSON Schema
io.zeebe.command.v1.ModifyProcessInstanceRequest	JSON Schema
io.zeebe.command.v1.ModifyProcessInstanceResponse	JSON Schema
io.zeebe.command.v1.PublishMessageRequest	JSON Schema
io.zeebe.command.v1.PublishMessageResponse	JSON Schema
io.zeebe.command.v1.ResolveIncidentRequest	JSON Schema
io.zeebe.command.v1.ResolveIncidentResponse	JSON Schema
io.zeebe.command.v1.SetVariablesRequest	JSON Schema
io.zeebe.command.v1.SetVariablesResponse	JSON Schema
io.zeebe.command.v1.ThrowErrorRequest	JSON Schema
io.zeebe.command.v1.ThrowErrorResponse	JSON Schema
io.zeebe.command.v1.TopologyRequest	JSON Schema
io.zeebe.command.v1.TopologyResponse	JSON Schema
io.zeebe.command.v1.UpdateJobRetriesRequest	JSON Schema
io.zeebe.command.v1.UpdateJobRetriesResponse	JSON Schema

Zeebe Cloudevents Events

This Cloudevents gateway produces the following events via the integrated http sender sink.

Decision

Decision JSON Schema

Cloudevent Type
io.zeebe.event.v1.Decision.created

Decision Evaluation

DecisionEvaluation JSON Schema

Cloudevent Type
io.zeebe.event.v1.DecisionEvaluation.evaluated
io.zeebe.event.v1.DecisionEvaluation.failed

Decision Requirements

DecisionRequirements JSON Schema

Cloudevent Type
io.zeebe.event.v1.DecisionRequirements.created

Deployment

Deployment JSON Schema

Cloudevent Type
io.zeebe.event.v1.Deployment.create
io.zeebe.event.v1.Deployment.created
io.zeebe.event.v1.Deployment.distribute
io.zeebe.event.v1.Deployment.distributed
io.zeebe.event.v1.Deployment.fullyDistributed

Deployment Distribution

DeploymentDistribution JSON Schema

Cloudevent Type
io.zeebe.event.v1.DeploymentDistribution.distributing
io.zeebe.event.v1.DeploymentDistribution.complete
io.zeebe.event.v1.DeploymentDistribution.completed

Error

Error JSON Schema

Cloudevent Type
io.zeebe.event.v1.Error.created

Escalation

Escalation JSON Schema

Cloudevent Type
io.zeebe.event.v1.Escalation.escalated
io.zeebe.event.v1.Escalation.notEscalated

Incident

Incident JSON Schema

Cloudevent Type
io.zeebe.event.v1.Incident.created
io.zeebe.event.v1.Incident.resolve
io.zeebe.event.v1.Incident.resolved

Job

Job JSON Schema

Cloudevent Type
io.zeebe.event.v1.Job.created
io.zeebe.event.v1.Job.complete
io.zeebe.event.v1.Job.completed
io.zeebe.event.v1.Job.timeOut
io.zeebe.event.v1.Job.timedOut
io.zeebe.event.v1.Job.fail
io.zeebe.event.v1.Job.failed
io.zeebe.event.v1.Job.updateRetries
io.zeebe.event.v1.Job.retriesUpdated
io.zeebe.event.v1.Job.canceled
io.zeebe.event.v1.Job.throwError
io.zeebe.event.v1.Job.errorThrown
io.zeebe.event.v1.Job.recurAfterBackoff
io.zeebe.event.v1.Job.recurredAfterBackoff

Job Batch

JobBatch JSON Schema

Cloudevent Type
io.zeebe.event.v1.JobBatch.activate
io.zeebe.event.v1.JobBatch.activated

Message

Message JSON Schema

Cloudevent Type
io.zeebe.event.v1.Message.publish
io.zeebe.event.v1.Message.published
io.zeebe.event.v1.Message.expire
io.zeebe.event.v1.Message.expired

Message Start Event Subscription

MessageStartEventSubscription JSON Schema

Cloudevent Type
io.zeebe.event.v1.MessageStartEventSubscription.created
io.zeebe.event.v1.MessageStartEventSubscription.correlated
io.zeebe.event.v1.MessageStartEventSubscription.deleted

Message Subscription

MessageSubscription JSON Schema

Cloudevent Type
io.zeebe.event.v1.MessageSubscription.create
io.zeebe.event.v1.MessageSubscription.created
io.zeebe.event.v1.MessageSubscription.correlating
io.zeebe.event.v1.MessageSubscription.correlate
io.zeebe.event.v1.MessageSubscription.correlated
io.zeebe.event.v1.MessageSubscription.reject
io.zeebe.event.v1.MessageSubscription.rejected
io.zeebe.event.v1.MessageSubscription.delete
io.zeebe.event.v1.MessageSubscription.deleted

Process

Process JSON Schema

Cloudevent Type
io.zeebe.event.v1.Process.created

Process Event

ProcessEvent JSON Schema

Cloudevent Type
io.zeebe.event.v1.ProcessEvent.triggering
io.zeebe.event.v1.ProcessEvent.triggered

Process Instance

ProcessInstance JSON Schema

Cloudevent Type
io.zeebe.event.v1.ProcessInstance.cancel
io.zeebe.event.v1.ProcessInstance.sequenceFlowTaken
io.zeebe.event.v1.ProcessInstance.elementActivating
io.zeebe.event.v1.ProcessInstance.elementActivated
io.zeebe.event.v1.ProcessInstance.elementCompleting
io.zeebe.event.v1.ProcessInstance.elementCompleted
io.zeebe.event.v1.ProcessInstance.elementTerminating
io.zeebe.event.v1.ProcessInstance.elementTerminated
io.zeebe.event.v1.ProcessInstance.activateElement
io.zeebe.event.v1.ProcessInstance.completeElement
io.zeebe.event.v1.ProcessInstance.terminateElement

Process Instance Creation

ProcessInstanceCreation JSON Schema

Cloudevent Type
io.zeebe.event.v1.ProcessInstanceCreation.create
io.zeebe.event.v1.ProcessInstanceCreation.created
io.zeebe.event.v1.ProcessInstanceCreation.createWithAwaitingResult

Process Instance Modification

ProcessInstanceModification JSON Schema

Cloudevent Type
io.zeebe.event.v1.ProcessInstanceModification.modify
io.zeebe.event.v1.ProcessInstanceModification.modified

Process Instance Result

ProcessInstanceResult JSON Schema

Cloudevent Type
io.zeebe.event.v1.ProcessInstanceResult.completed

Process Message Subscription

ProcessMessageSubscription JSON Schema

Cloudevent Type
io.zeebe.event.v1.ProcessMessageSubscription.creating
io.zeebe.event.v1.ProcessMessageSubscription.create
io.zeebe.event.v1.ProcessMessageSubscription.created
io.zeebe.event.v1.ProcessMessageSubscription.correlate
io.zeebe.event.v1.ProcessMessageSubscription.correlated
io.zeebe.event.v1.ProcessMessageSubscription.deleting
io.zeebe.event.v1.ProcessMessageSubscription.delete
io.zeebe.event.v1.ProcessMessageSubscription.deleted

Timer

Timer JSON Schema

Cloudevent Type
io.zeebe.event.v1.Timer.created
io.zeebe.event.v1.Timer.trigger
io.zeebe.event.v1.Timer.triggered
io.zeebe.event.v1.Timer.canceled

Variable

Variable JSON Schema

Cloudevent Type
io.zeebe.event.v1.Variable.created
io.zeebe.event.v1.Variable.updated

Variable Document

VariableDocument JSON Schema

Cloudevent Type
io.zeebe.event.v1.VariableDocument.update
io.zeebe.event.v1.VariableDocument.updated