Workflows
workflows
Methods
Cancel Workflow -> string
post/v1/workflows/{key}/cancel
When invoked for a workflow using a specific workflow key and cancellation key, will cancel any queued workflow runs associated with that key/cancellation key pair. Can optionally be provided one or more recipients to scope the request to.
Parameters
key: string
Request example
200Example
Trigger Workflow -> { workflow_run_id }
post/v1/workflows/{key}/trigger
Trigger a workflow specified by the key to run for the given recipients, using the parameters provided. Returns an identifier for the workflow run request. All workflow runs are executed asynchronously.