Glossary¶
Audience: Everyone · Tags:
reference,beginner,glossary
Every SnapLink term, defined once, in plain language. When another doc uses a bolded term you don't recognize, this is the page it's pointing to.
Core concepts¶
Action
A step a flow performs after its trigger fires. Current actions: REST request
(rest_sdk/request), send email (email/send_email), send a Slack
message, send a Teams message, and create a HubSpot contact. A flow can have
one or more actions, run in order. See Creating Flows.
Connection
A configured instance of a connector, with (optionally) a credential attached,
managed through the /connections API. A connection is the lower-level
resource that sits underneath an installed connector.
See Connectors.
Connector
An integration with an external system — or with SnapLink's own webhook
trigger — defined by a connector key, an auth type (none, oauth, or
custom), and the capabilities (trigger types and action types) it supports.
See Connectors.
Definition
The JSON that describes a flow's trigger and actions:
{trigger:{key,connectorKey,triggerType}, actions:[{key,connectorKey,actionType,input}]}.
Every draft and every version has one. See Flow Validation.
Flow A saved automation: one trigger plus one or more actions. A flow has an id, a name, a status (active or archived), and a version history. See Managing Flows.
Trigger
What starts a flow. Today the only trigger type is webhook. See
Webhook connector.
Workspace The top-level container that owns flows, connections, installed connectors, and runs. Every resource in SnapLink belongs to exactly one workspace. See Managing Flows.
Workspace role A member's permission level inside a workspace: owner (assigned automatically to whoever creates the workspace), admin, or member. These are the only three roles that exist.
Alphabetical reference¶
AI doctrine SnapLink's rule that AI only ever drafts flows — it never activates, executes, or sees credentials. A human always reviews and approves before anything runs. See AI Flow Drafting.
Audit (run) The read-only record of user and system actions taken on a run (e.g. a manual retry or cancellation) — one of three views into a run's history, alongside its timeline and events. See Flow Debugger.
Bearer token
The credential issued at signup or login, sent as Authorization: Bearer
<token> on every authenticated API call. See API Reference.
Check (Snap Studio) Running design-time validation on a plan before saving it. Check surfaces plain-language "problems," each tied to a specific step or field, so you can fix issues before the flow is ever saved. See Snap Studio.
Connector — see Core concepts.
Connector lifecycle states The states an installed connector moves through: installed → configured → certified → active, with disabled and deprecated reachable from any of those four states. See Connectors.
Connection — see Core concepts.
Definition — see Core concepts.
Draft An unpublished, editable version of a flow's definition. You edit a flow by creating a draft and then promoting it; nothing runs from a draft until it's promoted. See Editing Flows.
Engine (plan)
The field on a plan reporting who drafted it: "llm" means a real
large language model (e.g. Claude, via the configured AI provider) drafted
it; "rules" means the deterministic keyword-based planner drafted it — used
automatically whenever no AI provider is configured or the AI call fails. See
AI Flow Drafting.
Envelope
The JSON wrapper around every API response. On success it's {ok,data} for
most endpoints, or {data} alone for marketplace and flow-designer endpoints.
On failure it's always {ok:false,error:{code,message,details?}}. See
API Reference.
Error code — see Failure taxonomy / error code.
Events — see Timeline / events / audit.
Failure taxonomy / error code
The category assigned to why a step failed, so you know how to respond: auth
(credential missing/expired/invalid), rate_limit (the app throttled the
request), timeout (the app was too slow), upstream_5xx (the app returned a
server error), bad_request (the inputs were wrong), blocked (the
destination was blocked, e.g. by SSRF protection), or
unknown. See Flow Debugger.
Flow — see Core concepts.
Flow debugger The read-only view of a single run: its timeline, each step's status, the connector invocations it made, the failure cause (if any), and a suggested fix. See Flow Debugger.
Installed connector A connector that has been added to a workspace through the Marketplace, tracked through the connector lifecycle states from installed through to active (or disabled/deprecated). See Connectors.
Marketplace The in-app catalog for browsing, searching, and installing connectors into a workspace. See Connectors.
Plan Snap Studio's intermediate representation of a not-yet-saved flow: a name, a summary, an ordered list of steps (one trigger plus one or more actions) with editable fields, and any outstanding questions. Every plan carries an engine field. See Snap Studio.
Quick Send Snap Studio's mode for sending a single message immediately to an email address or a URL, without saving a flow. See Snap Studio.
Retry attempt A recorded retry of a failed step, tracked as part of that step's history within a run. See Flow Debugger.
Run (execution) One actual execution of a flow — created by its webhook firing, a manual "run now," or a Snap Studio test-run. Every run has an id and a status. See Monitoring Runs.
Run status
Exactly one of: queued, running, succeeded, failed, cancelled,
retry_pending, retry_running, or retry_exhausted. See
Monitoring Runs.
Snap Studio
The guided, three-stage, accessible flow builder — Describe → Review & edit
→ Save & test — available at /snap in the app. See Snap Studio.
SSRF protection The safeguard that blocks the REST action from reaching private or internal network addresses, so a flow can't be used to probe your own infrastructure. See REST connector.
Step One action's execution within a run, with its own status and — if it failed — an error code. See Flow Debugger.
Step card The visual representation of one plan step in Snap Studio's Review & edit stage: a "WHEN" card for the trigger, or a "THEN" card for an action. See Snap Studio.
Template A ready-made starter flow definition you can install instead of building from scratch. Seven exist today. See the Template Catalog.
Test run (Snap Studio) The one real execution Snap Studio performs immediately after you save a flow, so you can see it actually work before you trust it. See Snap Studio.
Timeline / events / audit Three read-only views into a run's history: the timeline is the chronological sequence of what happened, events are the discrete recorded occurrences that make it up, and the audit record is what users or the system did to the run (e.g. cancel, retry). See Flow Debugger.
Trigger — see Core concepts.
Validation error
One of the specific reasons a flow definition fails validation:
invalid_structure, unsupported_trigger, missing_connector,
missing_capability, missing_credential, schema_mismatch,
duplicate_key, orphan_node, or cycle. See
Flow Validation.
Version A promoted (published) snapshot of a flow's definition. Promoting a draft creates a new version and makes it the flow's current one; older versions remain in history. See Editing Flows.
Webhook
SnapLink's only trigger type: a private URL
(/api/v1/webhooks/<flowId>/<secret>) that starts a flow when something
POSTs to it. See Webhook connector.
Webhook secret The unguessable token embedded in a webhook's URL that authorizes requests to it. It can be rotated, with a grace window during which the old value still works. See Webhook connector.
Workspace — see Core concepts.
Workspace role — see Core concepts.
Related: Guides · Connectors · Snap Studio · API Reference