Skip to content
Disclose Bot

List workflow versions

GET
/v1/channels/{channel_id}/workflow_versions
 
curl --request GET \
  --url http://api.disclosebot.localdev:3000/v1/channels/example/workflow_versions \
  --header 'Authorization: Bearer <token>'

Every version of the channel workflow, oldest first. The running version is the one whose number matches the channel running_version_number.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
channel_id
required
string

Query Parameters

Section titled “Query Parameters ”
page[number]
integer
page[size]
integer
q[number_gteq]
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
type
required
string
Allowed values: workflow_version
attributes
required
object
number
required
integer
definition
required

The flat workflow definition: one entry per step keyed by name

object
steps
required
object
key
additional properties

One step of a workflow definition; the fields depend on kind

object
kind
required
string
Allowed values: triage transmit
needs

Names of the steps this step runs after

Array<string>
task

Triage only

string
Allowed values: summary scope duplicate validity severity
engine

Triage only; rule is available for scope and duplicate

string
Allowed values: ai rule
scale

Triage, severity only

string
Allowed values: standard custom
instructions

Triage, severity with the custom scale

string
<= 2000 characters
method

Triage, duplicate with the ai engine

string
Allowed values: prompt embeddings
lookback_days

Triage, duplicate only

integer
>= 1 <= 365
public_key_id

Transmit only; the body is encrypted to this key before delivery, and sent as it stands without one

string format: uuid
integration

Transmit only

object
type
required
string
Allowed values: Webhook LocalApp
id
required
string format: uuid
cloaked

Transmit only; what to do with a report the reporter encrypted in the browser: send its ciphertext as it stands, or send no body

string
default: send
Allowed values: send drop
only_when

Transmit only; result key to the allowed values

object
key
additional properties
Array<string>
definition_hash
required
string
committed_at
required
string format: date-time
committed_by_id
string format: uuid
nullable
summary
string
nullable
created_at
string format: date-time
relationships
object
workflow
object
Example 
{
  "data": [
    {
      "type": "workflow_version",
      "attributes": {
        "definition": {
          "steps": {
            "additionalProperty": {
              "kind": "triage",
              "task": "summary",
              "engine": "ai",
              "scale": "standard",
              "method": "prompt",
              "integration": {
                "type": "Webhook"
              },
              "cloaked": "send"
            }
          }
        }
      }
    }
  ]
}

401

Section titled “401 ”

Unauthorized

404

Section titled “404 ”

Channel without a workflow