Response format

Overview

Every action returns a response in the same standard envelope. The envelope always has two top-level fields:

Field Type Description
result.data object The action’s output data. The shape varies by action, see the individual action page for the specific fields.
result.errors array of objects Error details when the action fails. Each item has a message string. On success this array is empty.

Referencing action output in JSONata

When you add an action step to an automation, Skedulo assigns its response to a variable name based on the action name, converted to camelCase. For example:

Action JSONata variable
Create Job $createJob
Send Notification $sendNotification
GraphQL Query $graphqlQuery

To reference a field from a previous action’s response, use the variable name followed by the field path:

$createJob.result.data.uid

Each action page lists the specific fields available under result.data for that action.

Checking for errors

Use $count() in a JSONata expression to check whether an action produced any errors before using its output:

$count($createJob.result.errors) = 0

You can use this pattern in conditional branches within your automation to handle failures gracefully.

Example response

A typical successful response (for example, from Create Job):

{
  "result": {
    "data": {
      "uid": "00147d8e-5fa2-4b63-a670-af81566ddc11"
    },
    "errors": []
  }
}

A response when the action fails:

{
  "result": {
    "data": null,
    "errors": [
      {
        "message": "Region not found: the provided regionId does not exist."
      }
    ]
  }
}

Further reading