Stop Background Task

Stop a running background task.

Looks up the task type from the database and sends the appropriate abort signal to the Temporal workflow.

post/background-tasks/stop

Request

  • Base URL
    https://api.traversal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.traversal.com/background-tasks/stop
  • Auth
    none declared

Request body

task_idstring required

Primary key of the background task to stop

Response

Successful Response

workflow_idstring required

Temporal workflow ID that was targeted

task_typestring required

Type of background task

abortedboolean required

Whether the abort signal was sent successfully

errorstring nullable

Error message if something went wrong

Changes

No operation changes recorded.