Sign in
Signal

Event

A signal is an event of global scope (broadcast semantics) and is delivered to all active handlers. Internally this maps to the engine's signal event received builder method RuntimeService#createSignalEvent(). For more information about the signal behavior, see the Signal Events section of the BPMN 2.0 Implementation Reference.

post/signal

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/signal
  • Auth: HTTP basic

Request body

namestring

The name of the signal to deliver.

Note: This property is mandatory.

executionIdstring nullable

Optionally specifies a single execution which is notified by the signal.

Note: If no execution id is defined the signal is broadcasted to all subscribed handlers.

variablesobject nullable

A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object.

tenantIdstring nullable

Specifies a tenant to deliver the signal. The signal can only be received on executions or process definitions which belongs to the given tenant.

Note: Cannot be used in combination with executionId.

withoutTenantIdboolean nullable

If true the signal can only be received on executions or process definitions which belongs to no tenant. Value may not be false as this is the default behavior.

Note: Cannot be used in combination with executionId.

Response

Request successful.

Changes

No recorded changes to this operation across all 1 revision of this API.