Skip to main content
Get an action from the Application
curl --request GET \
  --url https://sapi.withsutro.com/applications/{applicationId}/actions/{actionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-sutro-api-client: <api-key>'
{
  "id": "<string>",
  "effects": [
    {
      "actionEffectId": "<string>",
      "effect": "<string>",
      "params": {},
      "bindParams": {},
      "next": "<string>",
      "onError": {
        "nextId": "<string>",
        "continueOriginalFlow": true
      }
    }
  ],
  "startEffectId": "<string>",
  "bindReturnValue": "<string>",
  "onError": {
    "nextId": "<string>",
    "continueOriginalFlow": true
  }
}

Authorizations

​
Authorization
string
header
required

Builder authentication and authorization

​
x-sutro-api-client
string
header
required

A unique identifier for the API Client making a request

Path Parameters

​
applicationId
string<uuid>
required
​
actionId
string
required
Pattern: ^urn:sutro:action:.*$

Response

The requested action

​
id
string
required

A unique identifier for the action. Must start with "urn:sutro:action:".

Pattern: ^urn:sutro:action:
​
effects
object[]
required
​
startEffectId
string
required

The ID of the first effect to execute

​
bindReturnValue
string
​
onError
object