Connectors
Run an action
Run one action of an app on its own, outside any workflow, with a connection and the values of its form: the values are checked against the app's live form, then the app runs them once. A read action (get, list, search...) is open to a viewer; any other can change data in the app and needs an editor. A run the app failed or did not answer is answered with its status. With validate_only, every check runs and the answer tells what would run, nothing runs; with validate_only_for_writes, a read runs and an action that can change data only answers that dry run.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace. List the ones your key can reach with GET /v1/workspaces.
region*RegionRegion whose catalog to read: besg or usnv
"besg""usnv"application/json- body
module_id*Module IdThe action, from the actions of GET .../workflows/modules/apps/<app_type> (its current version)
1 <= lengthmodule_version*Module VersionThe action's version, from the same answer
1 <= lengthconnection_id?|The connection the action uses, from GET .../connections (same region); None for an action that takes none
nullvalues?The action's form values, as the module form describes them (POST .../workflows/modules/forms)
validate_only?Validate OnlyRun every check of the run (action, role, connection, values against the app's live form) and answer what would run, with whether it only reads, without running it: a refused request answers the error the run would
falsevalidate_only_for_writes?Validate Only For Writestrue runs a read action at once and only validates a write action (as validate_only would); false runs any action
falseOK
application/json- response
module_id*Module Idmodule_version*Module Versionmodule_name*Module Nameapp_type*App Typeconnection_id*string|nullconnection_name*|The name of the connection the action used, None for none
is_read_action*Is Read ActionTrue for an action that only reads from the app (a viewer may run it); any other action can change data and needs an editor
status*ModuleRunStatusHow a run ended
"validated""succeeded""failed""outcome_unknown"data?JsonValueWhat the action answered, as the next step of a workflow would receive it; None unless it succeeded
nullis_data_truncated?Is Data TruncatedTrue when data was too large to answer: data is then the start of it as JSON text; narrow the action's filters to get it whole
falseerror_message?|Why the action failed, or why its outcome is unknown
nullcurl -X POST 'https://api.stacksync.com/v1/workspaces/0/workflows/modules/runs?region=usnv' \ -H 'Content-Type: application/json' \ -d '{ "module_id": "<module_id>", "module_version": "<module_version>"}'{ "module_id": "<module_id>", "module_version": "<module_version>", "module_name": "<module_name>", "app_type": "<app_type>", "connection_id": "<connection_id>", "connection_name": "<connection_name>", "is_read_action": false, "status": "validated", "data": "<data>", "is_data_truncated": false, "error_message": "<error_message>"}POSTGet a connector module form
The form of an action or trigger, for the connection and values chosen so far (the form changes as it is filled), and the options of the dropdowns asked for: the form a workflow step or a run of the action is filled from. No workflow is needed. A read: nothing is saved.
GETList syncs
List the syncs of the workspace in every region, newest first, with their apps, tables, columns and settings. Deleted syncs are not listed. No `region` parameter: both regions are read.