Skip to main content
Get an effect from an Action in the Application
curl --request GET \
  --url https://sapi.withsutro.com/applications/{applicationId}/actions/{actionId}/effects/{effectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-sutro-api-client: <api-key>'
{
  "actionEffectId": "<string>",
  "effect": "<string>",
  "params": {},
  "bindParams": {},
  "next": "<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:.*$
​
effectId
string
required

Response

The requested effect

​
actionEffectId
string
required

This is a unique ID to identify this action effect within its parent Action

​
effect
string
required

The ID of the effect to run

​
params
object

Static input parameters for the action effect

​
bindParams
object

Dynamic input parameters for the action effect. These MUST be SCodeValues

​
next
string

This is the ID of the next action effect in the sequence (if any)

​
onError
object