Camunda CancelProcessInstance

Camunda CancelProcessInstance
Certified
Cancel a running Camunda process instance

Terminates the process instance and every element instance inside it. Fails if the process instance is already finished.

yaml
type: io.kestra.plugin.camunda.CancelProcessInstance

Examples

Cancel a process instance started earlier in the flow.

yaml
id: cancel_camunda_process
namespace: company.team

tasks:
  - id: start_process
    type: io.kestra.plugin.camunda.CreateProcessInstance
    restAddress: "{{ secret('CAMUNDA_REST_ADDRESS') }}"
    clientId: "{{ secret('CAMUNDA_CLIENT_ID') }}"
    clientSecret: "{{ secret('CAMUNDA_CLIENT_SECRET') }}"
    authorizationServerUrl: "{{ secret('CAMUNDA_AUTH_SERVER_URL') }}"
    audience: "{{ secret('CAMUNDA_AUDIENCE') }}"
    processId: order-fulfillment

  - id: cancel_process
    type: io.kestra.plugin.camunda.CancelProcessInstance
    restAddress: "{{ secret('CAMUNDA_REST_ADDRESS') }}"
    clientId: "{{ secret('CAMUNDA_CLIENT_ID') }}"
    clientSecret: "{{ secret('CAMUNDA_CLIENT_SECRET') }}"
    authorizationServerUrl: "{{ secret('CAMUNDA_AUTH_SERVER_URL') }}"
    audience: "{{ secret('CAMUNDA_AUDIENCE') }}"
    processInstanceKey: "{{ outputs.start_process.processInstanceKey }}"

Properties

processInstanceKey *integerstring

Key of the process instance to cancel

audience string

OAuth2 audience

Required for OAuth2 against a self-managed cluster. The audience claim the identity provider must issue the token for, commonly zeebe-api. Derived from the cluster for Camunda SaaS, so leave it unset there.

authorizationServerUrl string

OAuth2 token endpoint

Required for OAuth2 against a self-managed cluster, for example http://localhost: 18080/auth/realms/camunda-platform/protocol/openid-connect/token.

clientId string

OAuth2 client ID

Set together with clientSecret and either authorizationServerUrl (self-managed) or clusterId (SaaS).

clientSecret string

OAuth2 client secret

Set together with clientId.

clusterId string

Camunda SaaS cluster ID

Switches the client to SaaS mode, where restAddress and grpcAddress are derived from the cluster ID and region.

grpcAddress string

gRPC gateway address of the Camunda cluster

For a self-managed cluster, for example http://localhost: 26500. Setting it without restAddress sends this task's commands over gRPC instead of REST.

password string

Password for Basic authentication

Must be set together with username.

region string

Camunda SaaS region

For example bru-2. Only used with clusterId.

restAddress string

REST API base URL of the Camunda cluster

For a self-managed cluster, the orchestration cluster address, for example http://localhost: 8080. Commands use the REST API unless only grpcAddress is set.

tenantId string

Camunda tenant ID

Camunda's own multi-tenancy identifier, unrelated to the Kestra tenant the flow runs in. Applied to every command this task sends. Defaults to <default>, which is the only tenant on a cluster that does not have multi-tenancy enabled.

transport string

Possible Values

RESTGRPC

Which API to send commands over

Defaults to gRPC on Camunda SaaS, and on a self-managed cluster to the API implied by whichever address is set, falling back to REST when both or neither are. SaaS defaults to gRPC because a default free-tier cluster answers 404 Not Found on the REST base the client derives, while gRPC succeeds with the same credentials. Set REST to opt back in if your cluster serves it.

username string

Username for Basic authentication

Must be set together with password. Mutually exclusive with the OAuth2 properties.