Tasks
Disable Stub
Disables the stub the action is running on, stopping any further actions from being run against it. Useful for enforcing spend limits, halting runaway automation, and closing off stubs that must not continue.
A disabled stub accepts no further actions. The only action that may still be run on it is _reopen_to, which is how a disabled stub is brought back.
This is the same effect as running the _disable action, but available as a task so that it can be run conditionally from inside another action. Its main use is in the Stubbucks Hard Limit Reached feedback action.
Disabling a stub is not a state change, it stops the stub entirely. Any followup action already queued for the stub will be discarded rather than run.
Basic usage
Parameters
reason string
An optional note describing why the stub was disabled. Recorded on the task result so it can be seen on the stubpost.
Default: not set
Result
Properties
stubref string
The stubref of the stub that was disabled. This is always the stub the action is running on.
disabled boolean
Always true when the task succeeds.
reason string
The reason passed in the params, if one was given.
Examples
Disable only when an org setting says to
Used in the stubbucks limit actions, so that an org controls whether reaching its limit actually stops the stub.