POST
/
transform
/
v1
/
jobs
curl --request POST \
  --url https://api.invopop.com/transform/v1/jobs \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {},
  "key": "<string>",
  "meta": {},
  "silo_entry_id": "<string>",
  "tags": [
    "<string>"
  ],
  "workflow_id": "<string>"
}'
{
  "args": {},
  "attachments": [
    {
      "desc": "My file description.",
      "hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "meta": {},
      "mime": "application/pdf",
      "name": "my-file.pdf",
      "size": 12345,
      "url": "<string>"
    }
  ],
  "completed_at": "<string>",
  "created_at": "<string>",
  "envelope": {},
  "faults": [
    {
      "code": "<string>",
      "message": "<string>",
      "provider": "pdf"
    }
  ],
  "id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
  "intents": [
    {
      "completed": true,
      "created_at": "<string>",
      "events": [
        {
          "args": {},
          "at": "2021-09-15T15:04:05.999Z",
          "code": "<string>",
          "index": 0,
          "message": "<string>",
          "silo_entry_id": "<string>",
          "status": "ERR"
        }
      ],
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "name": "PDF Generation",
      "provider": "pdf",
      "step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
      "updated_at": "<string>"
    }
  ],
  "key": "<string>",
  "silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "updated_at": "<string>",
  "workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}

Use this endpoint to execute a workflow, allowing the backend to assign the UUID.

This request will not be idempotent unless a key is provided. Keys are 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.
  • meta - a data object containing application-specific data used in the workflow’s initial actions to prepare and upload a silo entry.

The 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.

Query Parameters

​
wait
integer

Maximum number of seconds to block the http request waiting for the job to complete and provide a response.

Example:

60

Body

application/json

Response

200 - application/json
OK

The response is of type object.