POpocketflows
Trigger executions

Cancel a trigger execution

Changed on
post/trigger_executions/{id}/cancel

Request

Path parameters

idstring required

The ID of the trigger execution

Response

The cancelled TriggerExecution object, finished with reason User cancelled the execution

idstring required

The ID of the trigger execution

triggerstring required

The ID of the trigger (expandable to the full trigger object)

eventstring nullable required

The ID of the tracked event that created the execution (expandable to the full event object). null for executions created by internal events

customerstring required

The ID of the customer executing through the trigger (expandable to the full customer object)

scheduled_atstring nullable required

The scheduled time for the next step of the trigger execution

step_countinteger required

The index of the next step of the trigger to execute

current_step_idstring nullable required

The ID of the current step

status'pending' | 'in_progress' | 'retrying' | 'finished' | 'failed' | 'stopped' required

The status of the execution

failed_atstring nullable required

The time when the execution failed

failed_reasonstring nullable required

The reason for failure

finished_atstring nullable required

The time when the execution finished

finished_reasonstring nullable required

The reason for finishing

stopped_atstring nullable required

The time when the execution was stopped

started_atstring nullable required

The time when the execution started processing in ISO 8601 format

created_atstring required

The time the execution was created — i.e. when the customer was enrolled in the trigger — in ISO 8601 format

Changes

  • 0fcba2dc7246Revision changes
    • breaking

      the response's property type changed from no type to string for status

    • info

      removed subschema #1 from the response property anyOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • a8a7fb59cefcRevision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status