Flows Actions#

https://api.losant.com/applications/APPLICATION_ID/flows

Below are the various requests that can be performed against the Flows resource, as well as the expected parameters and the potential responses.

Get#

Returns the flows for an application

Method And Url #

GET https://api.losant.com/applications/APPLICATION_ID/flows

Authentication #

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flows.*, or flows.get.

Request Path Components #

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97

Request Query Parameters #

Name Required Description Default Example
sortField N Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated name sortField=name
sortDirection N Direction to sort the results by. Accepted values are: asc, desc asc sortDirection=asc
page N Which page of results to return 0 page=0
perPage N How many items to return per page 1000 perPage=10
filterField N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name filterField=name
filter N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. filter=my*flow
flowClass N Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience cloud flowClass=cloud
triggerFilter N Array of triggers to filter by - always filters against default flow version. See Workflow Trigger Filter for more details. triggerFilter[0][type]=webhook&triggerFilter[0][key]=575ed78e7ae143cd83dc4aab
includeCustomNodes N If the result of the request should also include the details of any custom nodes referenced by the returned workflows false includeCustomNodes=true

Request Headers #

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Curl Example #

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/flows

Successful Responses #

Code Type Description
200 Workflows Collection of flows

Error Responses #

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found

Get by Version#

Returns the flows by version for an application

Method And Url #

GET https://api.losant.com/applications/APPLICATION_ID/flows/version

Authentication #

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flows.*, or flows.getByVersion.

Request Path Components #

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97

Request Query Parameters #

Name Required Description Default Example
sortField N Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated name sortField=name
sortDirection N Direction to sort the results by. Accepted values are: asc, desc asc sortDirection=asc
page N Which page of results to return 0 page=0
perPage N How many items to return per page 1000 perPage=10
filterField N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name filterField=name
filter N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. filter=my*flow
flowClass N Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience cloud flowClass=cloud
version Y Return the workflow versions for the given version. version=myVersion
triggerFilter N Array of triggers to filter by - always filters against default flow version. See Workflow Trigger Filter for more details. triggerFilter[0][type]=webhook&triggerFilter[0][key]=575ed78e7ae143cd83dc4aab
includeCustomNodes N If the result of the request should also include the details of any custom nodes referenced by the returned workflows false includeCustomNodes=true

Request Headers #

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Curl Example #

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/flows/version?version=myVersion

Successful Responses #

Code Type Description
200 Workflow Versions Collection of flow versions

Error Responses #

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found

Import#

Import a set of flows and flow versions

Method And Url #

POST https://api.losant.com/applications/APPLICATION_ID/flows/import

Authentication #

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, flows.*, or flows.import.

Request Path Components #

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97

Request Headers #

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Request Body #

The body of the request should be serialized JSON that validates against the Workflow Import schema. For example, the following would be a valid body for this request:

{
  "flows": [
    {
      "id": "575ed18f7ae143cd83dc4aa6",
      "flowId": "575ed18f7ae143cd83dc4aa6",
      "applicationId": "575ec8687ae143cd83dc4a97",
      "creationDate": "2016-06-13T04:00:00.000Z",
      "lastUpdated": "2016-06-13T04:00:00.000Z",
      "name": "My Workflow",
      "description": "Description of my empty workflow",
      "enabled": true,
      "triggers": [],
      "nodes": [],
      "globals": [],
      "stats": {
        "runCount": 0,
        "errorCount": 0
      }
    }
  ],
  "flowVersions": []
}

Curl Example #

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"flows":[{"id":"575ed18f7ae143cd83dc4aa6","flowId":"575ed18f7ae143cd83dc4aa6","applicationId":"575ec8687ae143cd83dc4a97","creationDate":"2016-06-13T04:00:00.000Z","lastUpdated":"2016-06-13T04:00:00.000Z","name":"My Workflow","description":"Description of my empty workflow","enabled":true,"triggers":[],"nodes":[],"globals":[],"stats":{"runCount":0,"errorCount":0}}],"flowVersions":[]}' \
    https://api.losant.com/applications/APPLICATION_ID/flows/import

Successful Responses #

Code Type Description
201 Workflow Import Result Successfully imported workflows

Error Responses #

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found

Post#

Create a new flow for an application

Method And Url #

POST https://api.losant.com/applications/APPLICATION_ID/flows

Authentication #

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, flows.*, or flows.post.

Request Path Components #

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97

Request Query Parameters #

Name Required Description Default Example
includeCustomNodes N If the result of the request should also include the details of any custom nodes referenced by the returned workflows false includeCustomNodes=true

Request Headers #

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Request Body #

The body of the request should be serialized JSON that validates against the Workflow Post schema. For example, the following would be a valid body for this request:

{
  "name": "My New Workflow",
  "description": "Description of my new workflow"
}

Curl Example #

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"My New Workflow","description":"Description of my new workflow"}' \
    https://api.losant.com/applications/APPLICATION_ID/flows

Successful Responses #

Code Type Description
201 Workflow Successfully created flow

Error Responses #

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found