GET
/
transform
/
v1
/
workflows
/
{id}
curl --request GET \
  --url https://api.invopop.com/transform/v1/workflows/{id}
{
  "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": [
            {}
          ],
          "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": [
            {}
          ],
          "stop": true
        }
      ],
      "notes": "<string>",
      "summary": "<string>"
    }
  ],
  "updated_at": "<string>",
  "version": "<string>"
}

Path Parameters

​
id
string
required

ID of the workflow to fetch.

Example:

"5b45453c-cdd0-11ed-afa1-0242ac120002"

Response

200 - application/json
OK
​
country
string

ISO country code the workflow will be used for.

​
created_at
string

When the workflow was created.

​
description
string

Description of the workflow

​
disabled
boolean

When true, this workflow can no longer be used.

​
draft
boolean

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

​
hash
string

Partial SHA256 hash of the workflow's contents.

​
id
string

The UUID (any version) of the workflow.

Example:

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

​
name
string

Name of the workflow

​
rescue
object[] | null

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

​
schema
string

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

​
steps
object[] | null

List of steps to execute.

​
updated_at
string

When the workflow was last updated.

​
version
string

Version of the workflow's contents currently defined.

Was this page helpful?

Suggest edits