Connectors
Get 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.
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 module, from GET .../workflows/modules/apps/<app_type>
1 <= lengthmodule_version*Module VersionThe module version, from the same answer
1 <= lengthconnection_id?|The connection the step uses, from GET .../connections (same region); None before one is chosen
nullvalues?|The form values chosen so far: the form can change with them
nullobject_type?|The object the action works on, e.g. contacts: put into the action's object field (object_field of the form answer). None for an action without one, or when values already hold it
nulldropdown_ids?array<string>|The dropdowns whose options to load, from dropdown_ids of a previous answer
nullinclude_ready_dropdowns?Include Ready Dropdownstrue also loads the options of every dropdown that can list them now, and names in waiting_dropdown_ids the ones that wait for another field's value or could not load now; a built-in module ignores it (its stored form loads only dropdown_ids)
falseOK
application/json- response
input_schema*|The JSON schema of the step's values; a field whose options come from the app names them in dropdown_ids
connection_requirement*|nulldropdown_ids*array<string>Every dropdown the form declares
dropdowns*array<>The options of the dropdowns asked for
waiting_dropdown_ids?array<string>With include_ready_dropdowns: the dropdowns whose options are not listed: they wait for the fields they depend on, or could not load now
object_field?|The field that takes the action's object (the first field whose choice reloads the form), where object_type is put; None for a form without one
nullconnection_fields?array<string>The fields that hold the step's connection: filled from connection_id, never given in values
curl -X POST 'https://api.stacksync.com/v1/workspaces/0/workflows/modules/forms?region=usnv' \ -H 'Content-Type: application/json' \ -d '{ "module_id": "<module_id>", "module_version": "<module_version>"}'{ "input_schema": {}, "connection_requirement": { "is_required": false, "app_types": [ "<app_types>" ] }, "dropdown_ids": [ "<dropdown_ids>" ], "dropdowns": [ { "dropdown_id": "<dropdown_id>", "options": [ { "value": "<value>", "label": "<label>" } ], "has_more_options": false } ], "waiting_dropdown_ids": [ "<waiting_dropdown_ids>" ], "object_field": "<object_field>", "connection_fields": [ "<connection_fields>" ]}GETGet a connector app
One app's actions and triggers, each with the module_id and module_version the module form takes.
POSTRun 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.