Process methods: enable, pause
The Process Verbs enable, pause as typed SDK methods, with inputs, result, refusals and an example.
Reference for Process, one group of Process methods.
Process.enable
Enable turns a Process on for a Startup, so its Workflows start on their Triggers. Verb page.
interface ProcessVerbs {
enable(input: ProcessEnableInput, options?: SB.CallOptions): SB.Call<Process>
}Emits Process.enabled.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
process | Process | required | The Process to turn on. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
process | Process | required | The Process, now on. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const process = await $.Process.enable({ process: 'process_X2zteZ3CQI' })Process.pause
Pause stops a Process from starting new Actions; Actions already in progress finish. Verb page.
interface ProcessVerbs {
pause(input: ProcessPauseInput, options?: SB.CallOptions): SB.Call<Process>
}Emits Process.paused.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
process | Process | required | The Process to pause. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
process | Process | required | The paused Process. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const process = await $.Process.pause({ process: 'process_X2zteZ3CQI' })