Workflow Object

JSON object that describes a Workflow

Workflows are a list of API Calls that are called one after each other.

NameDescriptionRequired?
metaSee belowY
accessSee belowN
workflowSee belowY

meta

NameDescriptionRequired?
nameName of call for your referenceYes
descriptionDescription of call for your referenceNo
tagsList of tags for the call for your referenceNo
ownerID of owner of CallNo - readonly

access

NameDescriptionRequired?
publicIs the workflow shared with the APImetrics community?N
orgIs the workflow shared with your organization?N

workflow

NameDescriptionRequired?
call_idsList of API Call IDs, in order you want them called?N
stop_on_failureShould the workflow stop if we get an error response from one of the APIs?N
handle_cookiesShould cookies be handled and passed between API calls?N