Fetch all workflows

cURL

curl --request GET \
  --url https://api.invopop.com/transform/v1/workflows \
  --header 'Authorization: Bearer <token>'

{
  "created_at": "<string>",
  "limit": 123,
  "list": [
    {
      "country": "<string>",
      "created_at": "<string>",
      "description": "<string>",
      "disabled": true,
      "draft": true,
      "hash": "<string>",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "rescue": [
        {
          "action": "email.send",
          "config": {},
          "id": "186522a6-e697-4e34-8498-eee961bcb845",
          "name": "<string>",
          "next": [
            {
              "code": "<string>",
              "status": "OK",
              "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
              "steps": "<array>",
              "stop": true
            }
          ],
          "notes": "<string>",
          "summary": "<string>"
        }
      ],
      "schema": "<string>",
      "steps": [
        {
          "action": "email.send",
          "config": {},
          "id": "186522a6-e697-4e34-8498-eee961bcb845",
          "name": "<string>",
          "next": [
            {
              "code": "<string>",
              "status": "OK",
              "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
              "steps": "<array>",
              "stop": true
            }
          ],
          "notes": "<string>",
          "summary": "<string>"
        }
      ],
      "updated_at": "<string>",
      "version": "<string>",
      "versions": [
        {
          "created_at": "<string>",
          "hash": "<string>",
          "name": "<string>",
          "src": "<string>",
          "src_id": "<string>",
          "version": "<string>"
        }
      ]
    }
  ],
  "next_created_at": "<string>",
  "schema": "bill/invoice"
}

GET

transform

workflows

cURL

curl --request GET \
  --url https://api.invopop.com/transform/v1/workflows \
  --header 'Authorization: Bearer <token>'

{
  "created_at": "<string>",
  "limit": 123,
  "list": [
    {
      "country": "<string>",
      "created_at": "<string>",
      "description": "<string>",
      "disabled": true,
      "draft": true,
      "hash": "<string>",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "rescue": [
        {
          "action": "email.send",
          "config": {},
          "id": "186522a6-e697-4e34-8498-eee961bcb845",
          "name": "<string>",
          "next": [
            {
              "code": "<string>",
              "status": "OK",
              "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
              "steps": "<array>",
              "stop": true
            }
          ],
          "notes": "<string>",
          "summary": "<string>"
        }
      ],
      "schema": "<string>",
      "steps": [
        {
          "action": "email.send",
          "config": {},
          "id": "186522a6-e697-4e34-8498-eee961bcb845",
          "name": "<string>",
          "next": [
            {
              "code": "<string>",
              "status": "OK",
              "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
              "steps": "<array>",
              "stop": true
            }
          ],
          "notes": "<string>",
          "summary": "<string>"
        }
      ],
      "updated_at": "<string>",
      "version": "<string>",
      "versions": [
        {
          "created_at": "<string>",
          "hash": "<string>",
          "name": "<string>",
          "src": "<string>",
          "src_id": "<string>",
          "version": "<string>"
        }
      ]
    }
  ],
  "next_created_at": "<string>",
  "schema": "bill/invoice"
}

Authorizations

Authorization

string

header

required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Query Parameters

limit

integer

Maximum number of workflows to return.

Example:

100

created_at

string

Date from which results are provided.

Example:

"2023-08-02T00:00:00.000Z"

schema

string

Short schema name that the workflow will be allowed to process.

Example:

"bill/invoice"

Response

200 - application/json

created_at

string

First or queried timestamp when the first entry in the page was created.

limit

integer

Maximum number of objects returned in a page.

list

List · object[] | null

List of workflows.

Show child attributes

list.country

string

ISO country code the workflow will be used for.

list.created_at

string

When the workflow was created.

list.description

string

Description of the workflow

list.disabled

boolean

When true, this workflow can no longer be used.

list.draft

boolean

When true, this workflow is still in draft mode and will not be used in jobs.

list.hash

string

Partial SHA256 hash of the workflow's contents.

list.id

string

The UUID (any version) of the workflow.

Example:

"186522a6-e697-4e34-8498-eee961bcb845"

list.name

string

Name of the workflow

list.rescue

Rescue · object[] | null

List of steps to execute when a KO status is returned by a previous step and not explicitly managed.

Show child attributes

list.rescue.action

string

ID of the action to execute

Example:

"email.send"

list.rescue.config

Configuration · object

JSON configuration sent to the provider

list.rescue.id

string

The UUID (any version) of the step.

Example:

"186522a6-e697-4e34-8498-eee961bcb845"

list.rescue.name

string

Name of the step

list.rescue.next

Next · object[]

Optional array of next steps to execute after this one.

Show child attributes

list.rescue.next.code

string

Code to match against

list.rescue.next.status

enum<string>

Step status to match against, when empty this next step will always be executed.

Available options:

OK,

SKIP,

KO,

TIMEOUT

list.rescue.next.step_id

string

ID of the step to execute next.

Example:

"186522a6-e697-4e34-8498-eee961bcb845"

list.rescue.next.steps

Steps · array

Array of steps to execute

list.rescue.next.stop

boolean

When true, the workflow will stop.

list.rescue.notes

string

Additional internal details

list.rescue.summary

string

Summary of the step's configuration.

list.schema

string

Short schema name that the workflow will be allowed to process.

list.steps

Steps · object[] | null

List of steps to execute.

Show child attributes

list.steps.action

string

ID of the action to execute

Example:

"email.send"

list.steps.config

Configuration · object

JSON configuration sent to the provider

list.steps.id

string

The UUID (any version) of the step.

Example:

"186522a6-e697-4e34-8498-eee961bcb845"

list.steps.name

string

Name of the step

list.steps.next

Next · object[]

Optional array of next steps to execute after this one.

Show child attributes

list.steps.next.code

string

Code to match against

list.steps.next.status

enum<string>

Step status to match against, when empty this next step will always be executed.

Available options:

OK,

SKIP,

KO,

TIMEOUT

list.steps.next.step_id

string

ID of the step to execute next.

Example:

"186522a6-e697-4e34-8498-eee961bcb845"

list.steps.next.steps

Steps · array

Array of steps to execute

list.steps.next.stop

boolean

When true, the workflow will stop.

list.steps.notes

string

Additional internal details

list.steps.summary

string

Summary of the step's configuration.

list.updated_at

string

When the workflow was last updated.

list.version

string

Version of the workflow's contents currently defined.

list.versions

Versions · object[]

List of previously published versions of this workflow, only provided when requesting the primary workflow.

Show child attributes

list.versions.created_at

string

Timestamp of when the version was created.

list.versions.hash

string

Partial hash to identify the workflow definition.

list.versions.name

string

Name of the previous version.

list.versions.src

string

Key for the source of the version when created, like 'user'.

list.versions.src_id

string

ID of the source object that published the version.

list.versions.version

string

Version number of the workflow.

next_created_at

string

Timestamp that indicates the start of the next page of results, if any.

schema

string

Short schema name that the workflows have been filtered by.

Example:

"bill/invoice"

Delete Create a workflow

⌘I

API

Silo

Transform

Sequences

Access

Apps

Utils

Fetch all workflows

Authorizations

Query Parameters

Response