Delete Workflow Signal

deleteWorkflowSignal Mutation

Deletes a WorkflowSignal from the system.

Arguments

Name
Type
Description

id

ID!

The unique identifier of the workflow signal to delete

Return Type

WorkflowSignalDeletePayload! - Contains information about the deleted workflow signal.

Return Fields

WorkflowSignalDeletePayload:

Field
Type
Description

deletedID

ID

The ID of the deleted workflow signal

Usage Example

mutation {
  deleteWorkflowSignal(id: "signal_456") {
    deletedID
  }
}

JavaScript Example

Important Notes

  • Deleting a workflow signal removes the event handler from the associated workflow

  • This operation permanently removes the signal definition and cannot be undone

  • Ensure proper authorization before performing this operation

  • Events matching the deleted signal's eventName will no longer trigger the workflow

  • If this was the only start signal (start: true) for a workflow, the workflow may become unreachable

  • Consider the impact on workflow functionality before deletion

  • Review dependencies on this signal before deletion to avoid breaking event-driven processes

Last updated

Was this helpful?