key
property is provided, it will be checked for uniqueness within the current workspace and are valid for up to 2 years.
To execute a job, provide one of the following fields:
silo_entry_id
- preferred, the UUID of the silo entry to process with the workflow.data
- raw GOBL data of the job, which will be persisted to the silo before processing.args
- a data object containing application-specific data used in the workflow’s initial actions to prepare and upload a silo entry.
wait
query parameter can cause the server to block the incoming HTTP request and wait for up to the specified number of seconds. Typically, a workflow executes in under a second, but some actions may take longer. We recommend using the wait
query parameter only in sandbox or testing environments, as workflows can sometimes exceed expected durations due to network failures or other temporary issues.
Arguments (args
) are composed of string key-value pairs tailored to specific applications. Binary data can be included using Data URIs (data:
), which must specify the content type and include a name
parameter. For example: data:text/plain;name=example.txt;base64,ZGF0YQ==
. Any data provided via this method will be automatically uploaded to the Silo Spool service and will remain accessible only through tokens issued for the corresponding workspace.Authorizations
Use the Bearer
scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>
Path Parameters
ID of the job to create.
"5b45453c-cdd0-11ed-afa1-0242ac120002"
Query Parameters
Maximum number of seconds to block the http request waiting for the job to complete and provide a response.
60
Body
WorkflowID description
Additional arguments that may be used by workflow actions. Binary data may provided inside a Data URI, including the 'name' parameter.
Raw JSON data of the GOBL Envelope or Object when the Silo Entry ID is empty.
Key to associate with the job for idempotency.
ID for the entry in the silo as an alternative for the raw data object.
Tags to associate with the job.
Response
Accepted
Any additional arguments that might be used by workflow actions.
Any attachments that have been generated while processing the job in the workflow will be here.
When this job was completed, will be nil if still ongoing.
When the job was created.
Raw JSON data of the complete GOBL Envelope.
Array of fault objects that represent errors that occurred during the processing of the job.
The UUID v7 or v1 of the job
"5b45453c-cdd0-11ed-afa1-0242ac120002"
Array of intent objects following the execution of each of the steps of the associated workflow.
Key assigned to the job, used to identify it in the system.
"75fa764a-cdd0-11ed-afa1-0242ac120002"
Last known status text for this job.
Any tags that may be useful to be associated with the job.
When the job was last updated.
"186522a6-e697-4e34-8498-eee961bcb845"