REST API Reference

The WEXTL REST v1 API — versioned, frozen-additive, and machine-readable via a single OpenAPI document.

AI-assisted documentation

This documentation is compiled from our own product source code and internal specs, the platform's public API specification, and anonymized requests logs we collect from our support team[2].

v1 overview

The REST API lets you create workflows, run them, and inspect run history from any HTTP client. Every route lives under a single versioned prefix and returns a consistent JSON envelope — see Errors & rate limits for the shape.

The full per-resource reference below — every endpoint, its parameters, request/response schemas, and a runnable curl + TypeScript SDK sample — renders directly from the machine-readable OpenAPI document at the path below, so it can never drift from what actually ships.

Machine-readable spec

The full contract is published as an OpenAPI document once the v1 surface ships, at the path below — unauthenticated, so your tooling (or an AI agent) can fetch it with no token.[3]

text

GET /api/v1/openapi.json

Authenticating requests

Every v1 request carries a bearer Personal Access Token or an OAuth 2.1 access token. See the Authentication guide for the full scope model and a key-rotation recipe.

References

WEXTL® REST v1 API — our own source implementation.
Our users' real API integrations and automations.
The machine-readable OpenAPI specification for the REST API.

Download the full OpenAPI 3.1 spec (JSON)

Workflows

13endpoints

GET/workflowsAuth required

List workflows (bounded, cursor-paginated).

Parameters

Name	In	Type	Description
cursor	query	string	Opaque continuation token from a previous response.
limit	query	integer	Page size. Default 50.
q	query	string	Free-text search on name + description.
status	query	string	—
folderId	query	string	Restrict to this folder and its descendants.
sortBy	query	string	—
sortDir	query	string	—
tagIds	query	string	Comma-separated tag ids.
tagMatch	query	string	—

Responses

200A page of workflow summaries.

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<WorkflowSummary>	—
next_cursor*	—	string \| null	—

data[] item (WorkflowSummary)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
active*	—	boolean	—
folderId	—	string \| null	—
nodeCount	—	integer	—
tagIds	—	array<string>	—
createdAt	—	integer	Epoch milliseconds.
updatedAt	—	integer	Epoch milliseconds.

Example response

json

{
  "data": [
    {
      "id": "abc123",
      "name": "My workflow",
      "active": true,
      "folderId": "fld_01HXEXAMPLE",
      "nodeCount": 3,
      "tagIds": [
        "..."
      ],
      "createdAt": 1719792000000,
      "updatedAt": 1719792000000
    }
  ],
  "next_cursor": null
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/workflows \
  -H "Authorization: Bearer wextl_..."

POST/workflowsAuth required

Create a new, empty (draft) workflow. Build its graph via POST .../ops afterwards.

Request body (required)

Name	In	Type	Description
name*	body	string	—
folderId	body	string \| null	Must reference an accessible folder.
teamId	body	string \| null	Must belong to the caller's org. Omit to use the org's default team.

Responses

201The created (empty) draft workflow.

400Invalid body — missing/oversized name, or an unresolvable folderId/teamId.

401No valid bearer token.

403Missing workflow:write scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	WorkflowCreateResult	—

data shape (WorkflowCreateResult)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
teamId*	—	string	—
folderId	—	string \| null	—
active*	—	boolean	—
createdAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "teamId": "team_01HXEXAMPLE",
    "active": true,
    "createdAt": 1719792000000,
    "folderId": "fld_01HXEXAMPLE"
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/workflows \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My workflow",
  "folderId": "fld_01HXEXAMPLE",
  "teamId": "team_01HXEXAMPLE"
}'

GET/workflows/{id}Auth required

Read a workflow's full DRAFT graph, or its deployed snapshot via ?view=deployed.

Parameters

Name	In	Type	Description
id*	path	string	—
view	query	string	Omit for the current draft. `deployed` reads the last Go Live snapshot; 404 workflow_not_deployed if never published.

Responses

200The workflow (draft or deployed, per ?view).

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

404Workflow not found (or, with ?view=deployed, never deployed — workflow_not_deployed).

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	one of 2 shapes	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "active": true,
    "nodes": [
      {
        "id": 12,
        "appId": "slack",
        "name": "Send a message",
        "moduleSlug": "sendMessage",
        "x": 420,
        "y": 180,
        "params": {
          "channel": "#general",
          "text": "Deployment finished."
        },
        "connectionId": "oauth2",
        "credentialId": "cred_01HXEXAMPLE"
      }
    ],
    "edges": [
      {
        "id": "e_12_18",
        "from": 12,
        "to": 18,
        "type": "normal",
        "order": 0
      }
    ],
    "description": "...",
    "folderId": "fld_01HXEXAMPLE",
    "teamId": "team_01HXEXAMPLE",
    "schedule": {
      "recurrence": {
        "kind": "interval",
        "every": 15,
        "unit": "min",
        "timezone": "Europe/London",
        "skipIfRunning": true
      },
      "executionTimeoutMs": 0
    },
    "createdAt": 1719792000000,
    "updatedAt": 1719792000000,
    "deployed": {
      "deployedAt": 1719792000000,
      "versionNo": 0,
      "contentHash": "..."
    }
  }
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

PATCH/workflows/{id}Auth required

Curated update: name, active, schedule (recurrence), and/or folderId.

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
name	body	string	—
active	body	boolean	Activate or deactivate the workflow.
recurrence	body	ScheduleRecurrence	Schedule recurrence object, or null to clear. Setting a schedule does not activate.
folderId	body	string \| null	Move into folder; null to unassign.

Responses

200Fields that were updated.

400Invalid body.

401No valid bearer token.

403Missing workflow:write scope.

404Workflow not found.

409Conflict — re-read and retry.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	object	—

data shape (object)

Name	In	Type	Description
id	—	string	—
updated	—	array<string>	—
name	—	string	—
active	—	boolean	—
folderId	—	string \| null	—

Example response

json

{
  "data": {
    "id": "abc123",
    "updated": [
      "..."
    ],
    "name": "My workflow",
    "active": true,
    "folderId": "fld_01HXEXAMPLE"
  }
}

Example request

bash

curl -X PATCH https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My workflow",
  "active": true,
  "recurrence": {
    "kind": "interval",
    "every": 15,
    "unit": "min",
    "timezone": "Europe/London",
    "skipIfRunning": true
  },
  "folderId": "fld_01HXEXAMPLE"
}'

DELETE/workflows/{id}Auth required

Permanently delete a workflow. Refused while active or deployed.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200Deleted.

401No valid bearer token.

403Missing workflow:write scope.

404Workflow not found.

409Workflow is active or deployed — deactivate/undeploy first.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	object	—

data shape (object)

Name	In	Type	Description
ok	—	boolean	—

Example response

json

{
  "data": {
    "ok": true
  }
}

Example request

bash

curl -X DELETE https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

POST/workflows/{id}/opsAuth required

Apply a batch of graph operations to a workflow.

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
ops*	body	array<object>	Batch of GraphOp objects. One of: add_node, update_params, update_config, connect, disconnect, remove_node, rename_node, set_credential, set_edge_filter.
expectedUpdatedAt*	body	integer	REQUIRED optimistic-concurrency precondition — the workflow `updatedAt` this batch was computed against (take it from a prior GET /workflows/{id}). Mismatch → 409 workflow_modified. Without it two agents editing the same workflow silently overwrite each other, since a batch replaces the whole nodes/edges set; omitting it is rejected with 400 VALIDATION_ERROR.

Responses

200The batch result — best-effort; a non-empty errors[] does not mean the whole batch was rejected.

400Invalid body, or the resulting graph fails the topology gate.

401No valid bearer token.

403Missing workflow:write scope, or the plan lacks API access.

404Workflow not found.

409workflow_modified — expectedUpdatedAt no longer matches; reload and retry.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	GraphOpsResult	—

data shape (GraphOpsResult)

Name	In	Type	Description
applied*	—	object	tempId → real node id, for every add_node that landed.
errors*	—	array<string>	Best-effort per-op failures — the rest of the batch still applies.
touched*	—	array<integer>	Node ids added or param/config-updated by this batch, including hub-scaffolded satellite/placeholder ids.
updatedAt	—	integer	The workflow's new updatedAt — pass it as expectedUpdatedAt on the next ops call to avoid conflicts.

Example response

json

{
  "data": {
    "applied": {
      "tmp_1": "42",
      "tmp_2": "43"
    },
    "errors": [
      "..."
    ],
    "touched": [
      0
    ],
    "updatedAt": 1719792000000
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE/ops \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "ops": [
    {
      "op": "..."
    }
  ],
  "expectedUpdatedAt": 1719792000000
}'

POST/workflows/{id}/deployAuth required

Go Live — publish the current draft as the deployed snapshot (idempotent).

Parameters

Name	In	Type	Description
id*	path	string	—

Request body

Name	In	Type	Description
expectedUpdatedAt	body	integer	Optimistic-concurrency precondition — the draft updatedAt this deploy was computed against. Mismatch → 409 workflow_modified.

Responses

200The new deployed snapshot summary.

401No valid bearer token.

403Missing workflow:write scope, or the plan lacks API access.

404Workflow not found.

409workflow_modified — expectedUpdatedAt no longer matches; reload and retry.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	DeployResult	—

data shape (DeployResult)

Name	In	Type	Description
workflowId*	—	string	—
contentHash*	—	string	—
versionNo*	—	integer	—
deployedAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": {
    "workflowId": "wf_01HXEXAMPLE",
    "contentHash": "...",
    "versionNo": 0,
    "deployedAt": 1719792000000
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE/deploy \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "expectedUpdatedAt": 1719792000000
}'

POST/workflows/{id}/validateAuth required

Validate a workflow's structure (duplicate ids, orphan edges, cycles, trigger placement). Run this before declaring a workflow correct.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200The validation result.

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

404Workflow not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	ValidateWorkflowResult	—

data shape (ValidateWorkflowResult)

Name	In	Type	Description
valid*	—	boolean	—
issues*	—	array<string>	Human-readable validation problems. Empty when valid is true.

Example response

json

{
  "data": {
    "valid": false,
    "issues": [
      "Node 7 has no incoming edges and is not the trigger."
    ]
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE/validate \
  -H "Authorization: Bearer wextl_..."

POST/workflows/{id}/resolve-expressionAuth required

Resolve a {{expr}} template against a node's available input data from the latest (or a specific) run — validates references like {{4.user_id}} before wiring them.

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
expression*	body	string	The expression template, e.g. '{{3.rows[0].name}}' or bare '3.rows[0].name'.
fromNodeId	body	string	The node id that uses this expression — helps locate its upstream nodes from the latest run.
runId	body	string	Optional run id to use for sample data. Defaults to the most recent run.

Responses

200The resolution attempt — resolved is null with error set when it could not be resolved (e.g. no runs yet).

400expression is required.

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

404Workflow not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	ResolveExpressionResult	—

data shape (ResolveExpressionResult)

Name	In	Type	Description
resolved*	—	any	The resolved value (any JSON type), or null when resolution failed or no run data exists yet.
resolvedType	—	string	typeof the resolved value, e.g. "string", "number", "object". Absent when resolved is null.
truncated	—	boolean	true when a large resolved string value was cut to fit the response budget.
error*	—	string \| null	Present when resolution failed, or when no runs exist yet for this workflow.

Example response

json

{
  "data": {
    "resolved": "user_42",
    "resolvedType": "string",
    "error": null
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE/resolve-expression \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "expression": "{{3.rows[0].name}}",
  "fromNodeId": "4"
}'

POST/workflows/{id}/webhookAuth required

Mint (or return the existing) inbound webhook URL for a workflow trigger node.

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
nodeId*	body	string	The webhook trigger node id (numeric id as a string).

Responses

200The webhook URL (idempotent — alreadyBound:true when a live one already existed).

400Missing nodeId, or the node is not a webhook trigger node.

401No valid bearer token.

403Missing webhook:write scope, or the plan lacks API access.

404Workflow or node not found.

409The node already has a DISABLED webhook record bound to it.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	Webhook	—

data shape (Webhook)

Name	In	Type	Description
webhookId*	—	string	—
url*	—	string	The inbound URL to POST trigger payloads to.
alreadyBound	—	boolean	—

Example response

json

{
  "data": {
    "webhookId": "wh_01HXEXAMPLE",
    "url": "https://eu1.wextl.com/hooks/wh_01HXEXAMPLE",
    "alreadyBound": true
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE/webhook \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "abc123"
}'

POST/workflows/{id}/runsAuth required

Start a run of the workflow's current draft (billing and structure checks apply).

Parameters

Name	In	Type	Description
id*	path	string	—
Idempotency-Key	header	string	Optional but strongly recommended when the client may retry. A caller-chosen unique string; retrying with the same key returns the SAME run rather than starting another. Without it a timeout-and-retry starts a second run, double-charging credits and repeating any external side effects the workflow performs.

Request body

Name	In	Type	Description
nodeId	body	string	Optional node id (numeric id as a string) to run from — a scoped run. Omit for a full-graph run.
upstreamOutputs	body	object	Optional nodeId→payload map to seed as upstream inputs. Mutually exclusive with seedFromRun.
seedFromRun	body	object	Seed from a past run node output (server-resolved). Mutually exclusive with upstreamOutputs.

Responses

201The run was created and enqueued.

400Invalid nodeId/inputs, or the workflow fails the topology gate (e.g. no runnable path).

401No valid bearer token.

402Payment required — billing problem blocking runs.

403Missing workflow:write scope, no active plan, or out of credits (PLAN_LIMIT_EXCEEDED).

404Workflow not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	StartRunResult	—

data shape (StartRunResult)

Name	In	Type	Description
runId*	—	string	—

Example response

json

{
  "data": {
    "runId": "run_01HXEXAMPLE"
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE/runs \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "abc123",
  "upstreamOutputs": {
    "12": {
      "message": "Hello world",
      "channel": "#general"
    }
  },
  "seedFromRun": {
    "runId": "run_01HXEXAMPLE",
    "nodeId": 0
  }
}'

PUT/workflows/{id}/tagsAuth required

Replace the full tag set on a workflow.

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
tagIds*	body	array<string>	—

Responses

200Tags assigned.

400Invalid body.

401No valid bearer token.

403Missing workflow:write scope.

404Workflow not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	SetWorkflowTagsResult	—

data shape (SetWorkflowTagsResult)

Name	In	Type	Description
ok*	—	boolean	—
tagIds*	—	array<string>	—

Example response

json

{
  "data": {
    "ok": true,
    "tagIds": [
      "tag_01HXEXAMPLE"
    ]
  }
}

Example request

bash

curl -X PUT https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE/tags \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "tagIds": [
    "..."
  ]
}'

POST/workflows/{id}/test-moduleAuth required

Execute a single app node with its current parameters (module test).

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
nodeId*	body	one of 2 shapes	—

Responses

200Module test result.

400Invalid body or non-app node.

401No valid bearer token.

403Missing workflow:write scope.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	object	The node's module output on success. Shape depends on the module — the same shape a real run's node output would have.

Example response

json

{
  "data": {
    "ok": true,
    "ts": "1719792000.000100",
    "channel": "#general"
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/workflows/wf_01HXEXAMPLE/test-module \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": "abc123"
}'

Variables

4endpoints

GET/variablesAuth required

List variable names and metadata for the organization (up to 500). Secret values are always returned as null.

Responses

200Every variable visible to this key.

401No valid bearer token.

403Missing variable:read scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<Variable>	—

data[] item (Variable)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
isSecret*	—	boolean	—
value*	—	string \| null	—
teamId*	—	string \| null	—
createdAt*	—	integer	Epoch milliseconds.
updatedAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": [
    {
      "id": "abc123",
      "name": "My workflow",
      "isSecret": false,
      "value": null,
      "teamId": "team_01HXEXAMPLE",
      "createdAt": 1719792000000,
      "updatedAt": 1719792000000
    }
  ]
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/variables \
  -H "Authorization: Bearer wextl_..."

GET/variables/{id}Auth required

Read one variable by id. A secret variable's value is always returned as null.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200The variable (value is null when isSecret is true).

401No valid bearer token.

403Missing variable:read scope, or the plan lacks API access.

404Variable not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	Variable	—

data shape (Variable)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
isSecret*	—	boolean	—
value*	—	string \| null	—
teamId*	—	string \| null	—
createdAt*	—	integer	Epoch milliseconds.
updatedAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "isSecret": false,
    "value": null,
    "teamId": "team_01HXEXAMPLE",
    "createdAt": 1719792000000,
    "updatedAt": 1719792000000
  }
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/variables/var_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

PUT/variables/{id}Auth required

Create or update a variable by name (upsert) — the {id} path segment IS the variable name, not a database id. Secrets are write-only.

Parameters

Name	In	Type	Description
id*	path	string	The variable name (letters/numbers/underscores, must start with a letter or underscore) — this call upserts by name.

Request body (required)

Name	In	Type	Description
value*	body	string	Required for a new non-secret variable. For an existing secret, a blank value keeps the current stored value.
isSecret	body	boolean	Whether this variable is a secret. Only takes effect on create — updating an existing variable never changes its stored secret status.
teamId	body	string \| null	Must belong to the caller's org. Omit for an org-level variable.

Responses

200An existing variable was updated.

201A new variable was created.

400Invalid body — bad name, missing value, a secret shorter than 6 characters, or an unresolvable teamId.

401No valid bearer token.

403Missing variable:write scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	SetVariableResult	—

data shape (SetVariableResult)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
isSecret*	—	boolean	—
teamId*	—	string \| null	—
updatedAt*	—	integer	Epoch milliseconds.
created*	—	boolean	true when this call created a new variable, false when it updated an existing one.

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "isSecret": false,
    "teamId": "team_01HXEXAMPLE",
    "updatedAt": 1719792000000,
    "created": true
  }
}

Example request

bash

curl -X PUT https://eu1.wextl.com/api/v1/variables/var_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "value": null,
  "isSecret": false,
  "teamId": "team_01HXEXAMPLE"
}'

DELETE/variables/{id}Auth required

Soft-delete a variable by database id (not name).

Parameters

Name	In	Type	Description
id*	path	string	The variable database id from list_variables / get_variable.

Responses

200Deleted.

401No valid bearer token.

403Missing variable:write scope.

404Variable not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	object	—

data shape (object)

Name	In	Type	Description
ok	—	boolean	—

Example response

json

{
  "data": {
    "ok": true
  }
}

Example request

bash

curl -X DELETE https://eu1.wextl.com/api/v1/variables/var_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

Runs

6endpoints

GET/runsAuth required

List runs of a workflow (bounded, cursor-paginated). workflowId is REQUIRED in v1 — org-wide listing is out of scope.

Parameters

Name	In	Type	Description
workflowId*	query	string	REQUIRED — scope the listing to this workflow.
cursor	query	string	—
limit	query	integer	Page size. Default 50.
q	query	string	Free-text search over status + id.

Responses

200A page of run summaries.

400workflowId query parameter is required.

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<RunSummary>	—
next_cursor*	—	string \| null	—

data[] item (RunSummary)

Name	In	Type	Description
id*	—	string	—
workflowId*	—	string \| null	—
status*	—	string	—
createdAt*	—	string \| null	ISO-8601 timestamp.
finishedAt	—	string \| null	ISO-8601 timestamp; null while the run is non-terminal.
creditsUsed*	—	number	—

Example response

json

{
  "data": [
    {
      "id": "abc123",
      "workflowId": "wf_01HXEXAMPLE",
      "status": "succeeded",
      "createdAt": "2024-07-01T12:00:00.000Z",
      "creditsUsed": 50,
      "finishedAt": null
    }
  ],
  "next_cursor": null
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/runs \
  -H "Authorization: Bearer wextl_..."

GET/runs/{id}Auth required

Get a run report: status, timestamps, error, and per-node status/error/output.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200The run report.

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

404Run not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	RunReport	—

data shape (RunReport)

Name	In	Type	Description
id*	—	string	—
workflowId	—	string	—
status*	—	string	—
createdAt	—	string \| null	—
finishedAt	—	string \| null	—
error	—	string \| null	—
nodes	—	array<RunNode>	—

Example response

json

{
  "data": {
    "id": "abc123",
    "status": "succeeded",
    "workflowId": "wf_01HXEXAMPLE",
    "createdAt": "2024-07-01T12:00:00.000Z",
    "finishedAt": null,
    "error": null,
    "nodes": [
      {
        "nodeId": 12,
        "label": "Send a message",
        "status": "completed",
        "output": {
          "ok": true,
          "ts": "1719792000.000100"
        }
      }
    ]
  }
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/runs/run_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

POST/runs/{id}/cancelAuth required

Cancel an in-flight workflow run.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200The run was cancelled.

400The run is already in a terminal state.

401No valid bearer token.

403Missing workflow:write scope, or the plan lacks API access.

404Run not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	CancelRunResult	—

data shape (CancelRunResult)

Name	In	Type	Description
ok*	—	boolean	—

Example response

json

{
  "data": {
    "ok": true
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/runs/run_01HXEXAMPLE/cancel \
  -H "Authorization: Bearer wextl_..."

POST/runs/{id}/rerunAuth required

Re-queue a finished run as a new attempt.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

201New attempt enqueued.

401No valid bearer token.

403Missing workflow:write scope.

404Run not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	RerunResult	—

data shape (RerunResult)

Name	In	Type	Description
runId*	—	string	—
status*	—	string	—
attemptNumber*	—	integer	—
updatedAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": {
    "runId": "run_01HXEXAMPLE",
    "status": "queued",
    "attemptNumber": 2,
    "updatedAt": 1719792000000
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/runs/run_01HXEXAMPLE/rerun \
  -H "Authorization: Bearer wextl_..."

POST/runs/{id}/retry-nodeAuth required

Resume a run from one failed node (same attempt).

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
nodeId*	body	integer	—
attemptNumber	body	integer	—

Responses

200Resume enqueued.

400Invalid body.

401No valid bearer token.

403Missing workflow:write scope.

404Run not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	RetryNodeResult	—

data shape (RetryNodeResult)

Name	In	Type	Description
runId*	—	string	—
status*	—	string	—
attemptNumber*	—	integer	—
nodeId*	—	integer	—
updatedAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": {
    "runId": "run_01HXEXAMPLE",
    "status": "running",
    "attemptNumber": 1,
    "nodeId": 12,
    "updatedAt": 1719792000000
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/runs/run_01HXEXAMPLE/retry-node \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "nodeId": 0,
  "attemptNumber": 0
}'

POST/runs/{id}/nodes/{nodeId}/respondAuth required

Submit a human-in-the-loop response and resume (or complete) the run.

Parameters

Name	In	Type	Description
id*	path	string	—
nodeId*	path	string	—

Request body (required)

Name	In	Type	Description
response*	body	object	The HITL response fields — shape depends on the node's configured response fields.
attemptNumber	body	integer	—

Responses

200Response recorded.

400Invalid body.

401No valid bearer token.

402Payment required for mid-flow resume.

403Missing workflow:write scope.

404Run not found.

409Conflict — resume already in flight or run terminal.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	RespondNodeResult	—

data shape (RespondNodeResult)

Name	In	Type	Description
ok*	—	boolean	—
resumed*	—	boolean	true when the run resumed execution past this node.
terminal*	—	boolean	true when this response completed the run (no further nodes to run).

Example response

json

{
  "data": {
    "ok": true,
    "resumed": true,
    "terminal": false
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/runs/run_01HXEXAMPLE/nodes/node_1/respond \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "response": {
    "approved": true,
    "comment": "Looks good, ship it."
  },
  "attemptNumber": 0
}'

Credentials

6endpoints

GET/credentialsAuth required

List the organization's stored credentials (names and metadata only; secret payloads are never returned).

Parameters

Name	In	Type	Description
cursor	query	string	—
limit	query	integer	Page size. Default 50.
appId	query	string	Optional app id to filter by.

Responses

200A page of credential summaries.

401No valid bearer token.

403Missing credential:read scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<Credential>	—
next_cursor*	—	string \| null	—

data[] item (Credential)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
appId*	—	string	—
type*	—	string	The connection type id.
status*	—	string	—
folderId	—	string \| null	—
createdAt*	—	integer	Epoch milliseconds.
updatedAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": [
    {
      "id": "abc123",
      "name": "My workflow",
      "appId": "slack",
      "type": "oauth2",
      "status": "succeeded",
      "createdAt": 1719792000000,
      "updatedAt": 1719792000000,
      "folderId": "fld_01HXEXAMPLE"
    }
  ],
  "next_cursor": null
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/credentials \
  -H "Authorization: Bearer wextl_..."

POST/credentialsAuth required

Create a credential when safe (no-auth or secrets already supplied). OAuth or missing secrets return status credential_required with a connect_url for a logged-in human.

Request body (required)

Name	In	Type	Description
appId*	body	string	—
connectionId*	body	string	—
name*	body	string	—
data	body	object	Secret field values when the caller already has them — keyed by the connection's parameter names (from get_module_spec / the connection spec), e.g. an api-key connection's `apiKey`. Never invent placeholders when calling this for real — the value shown here is illustrative only.
teamId	body	string \| null	—

Responses

200Created credential or credential_required handoff.

400Invalid body.

401No valid bearer token.

403Missing credential:write scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	CredentialCreateResult	—

data shape (CredentialCreateResult)

Name	In	Type	Description
credentialId	—	string	—
status	—	string	—
appId	—	string	—
connectionId	—	string	—
connect_url	—	string	—

Example response

json

{
  "data": {
    "credentialId": "abc123",
    "status": "succeeded",
    "appId": "slack",
    "connectionId": "abc123",
    "connect_url": "..."
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/credentials \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "appId": "slack",
  "connectionId": "abc123",
  "name": "My workflow",
  "data": {
    "apiKey": "sk_live_your_api_key_here"
  },
  "teamId": "team_01HXEXAMPLE"
}'

PATCH/credentials/{id}Auth required

Rename a credential or move its folder (never returns secrets).

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
name	body	string	—
folderId	body	string \| null	—

Responses

200Updated credential summary.

400Invalid body.

401No valid bearer token.

403Missing credential:write scope.

404Credential not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	Credential	—

data shape (Credential)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
appId*	—	string	—
type*	—	string	The connection type id.
status*	—	string	—
folderId	—	string \| null	—
createdAt*	—	integer	Epoch milliseconds.
updatedAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "appId": "slack",
    "type": "oauth2",
    "status": "succeeded",
    "createdAt": 1719792000000,
    "updatedAt": 1719792000000,
    "folderId": "fld_01HXEXAMPLE"
  }
}

Example request

bash

curl -X PATCH https://eu1.wextl.com/api/v1/credentials/cred_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My workflow",
  "folderId": "fld_01HXEXAMPLE"
}'

DELETE/credentials/{id}Auth required

Soft-delete a credential.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200Deleted.

401No valid bearer token.

403Missing credential:write scope.

404Credential not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	object	—

data shape (object)

Name	In	Type	Description
ok	—	boolean	—

Example response

json

{
  "data": {
    "ok": true
  }
}

Example request

bash

curl -X DELETE https://eu1.wextl.com/api/v1/credentials/cred_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

POST/credentials/{id}/verifyAuth required

Test whether a stored credential is accepted by the third-party service (never returns the secret).

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200Verification outcome.

401No valid bearer token.

403Missing credential:use scope.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	one of 2 shapes	—

Example response

json

{
  "data": {
    "status": "ok"
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/credentials/cred_01HXEXAMPLE/verify \
  -H "Authorization: Bearer wextl_..."

POST/credentials/dynamic-optionsAuth required

Fetch live RPC-backed field options (tables, channels, sheets, …).

Request body (required)

Name	In	Type	Description
appId*	body	string	—
rpcId*	body	string	—
credentialId	body	string	—
params	body	object	Optional dependency parameters for nested RPCs, e.g. { "tableId": "users" } to get columns for a table.

Responses

200Option items.

400Invalid body.

401No valid bearer token.

403Missing credential:use scope.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	DynamicOptionsResult	—

data shape (DynamicOptionsResult)

Name	In	Type	Description
items*	—	array<object>	—
truncated	—	boolean	true when the result was capped at 200 items.
total	—	integer	Present only when truncated.

Example response

json

{
  "data": {
    "items": [
      {
        "value": "C0123ABCDE",
        "label": "#general"
      },
      {
        "value": "C0456FGHIJ",
        "label": "#engineering"
      }
    ]
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/credentials/dynamic-options \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "appId": "slack",
  "rpcId": "abc123",
  "credentialId": "abc123",
  "params": {
    "tableId": "users"
  }
}'

Databases

6endpoints

GET/databasesAuth required

List the organization's built-in database tables.

Parameters

Name	In	Type	Description
limit	query	integer	—

Responses

200Database table summaries.

401No valid bearer token.

403Missing database:read scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<DatabaseSummary>	—
truncated*	—	boolean	—

data[] item (DatabaseSummary)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
columnCount*	—	integer	—
rowCount*	—	integer	—

Example response

json

{
  "data": [
    {
      "id": "abc123",
      "name": "My workflow",
      "columnCount": 3,
      "rowCount": 3
    }
  ],
  "truncated": true
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/databases \
  -H "Authorization: Bearer wextl_..."

POST/databasesAuth required

Create a built-in database table (DDL). Row writes are not available on the public API.

Request body (required)

Name	In	Type	Description
name*	body	string	—
description	body	string	—
columns*	body	array<DatabaseColumnInput>	—
teamId	body	string \| null	—

Responses

201Created table with generated column ids.

400Invalid body.

401No valid bearer token.

403Missing database:write scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	DatabaseSchema	—

data shape (DatabaseSchema)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
columns*	—	array<object>	—
rowCount*	—	integer	—
uniqueKeyColumnId	—	string	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "columns": [
      {
        "id": "abc123",
        "name": "My workflow",
        "type": "action",
        "required": true,
        "indexed": true
      }
    ],
    "rowCount": 3,
    "uniqueKeyColumnId": "abc123"
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/databases \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My workflow",
  "columns": [
    {
      "name": "Status",
      "type": "select",
      "required": false,
      "indexed": true
    }
  ],
  "description": "...",
  "teamId": "team_01HXEXAMPLE"
}'

GET/databases/{id}Auth required

Read one database table's column schema.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200Schema projection.

401No valid bearer token.

403Missing database:read scope, or the plan lacks API access.

404Database not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	DatabaseSchema	—

data shape (DatabaseSchema)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
columns*	—	array<object>	—
rowCount*	—	integer	—
uniqueKeyColumnId	—	string	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "columns": [
      {
        "id": "abc123",
        "name": "My workflow",
        "type": "action",
        "required": true,
        "indexed": true
      }
    ],
    "rowCount": 3,
    "uniqueKeyColumnId": "abc123"
  }
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/databases/db_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

PATCH/databases/{id}Auth required

Replace a table's column definitions with the full desired list (declarative).

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
columns*	body	array<DatabaseColumnInput>	—

Responses

200Updated schema.

400Invalid body.

401No valid bearer token.

403Missing database:write scope, or the plan lacks API access.

404Database not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	DatabaseSchema	—

data shape (DatabaseSchema)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
columns*	—	array<object>	—
rowCount*	—	integer	—
uniqueKeyColumnId	—	string	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "columns": [
      {
        "id": "abc123",
        "name": "My workflow",
        "type": "action",
        "required": true,
        "indexed": true
      }
    ],
    "rowCount": 3,
    "uniqueKeyColumnId": "abc123"
  }
}

Example request

bash

curl -X PATCH https://eu1.wextl.com/api/v1/databases/db_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "columns": [
    {
      "name": "Status",
      "type": "select",
      "required": false,
      "indexed": true
    }
  ]
}'

DELETE/databases/{id}Auth required

Soft-delete a built-in database table.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200Deleted.

401No valid bearer token.

403Missing database:write scope.

404Database not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	object	—

data shape (object)

Name	In	Type	Description
ok	—	boolean	—

Example response

json

{
  "data": {
    "ok": true
  }
}

Example request

bash

curl -X DELETE https://eu1.wextl.com/api/v1/databases/db_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

GET/databases/{id}/rowsAuth required

Read rows from a built-in database table (bounded). No public DML row writes.

Parameters

Name	In	Type	Description
id*	path	string	—
filters	query	string	JSON-encoded filter array.
sortColumnId	query	string	—
sortDir	query	string	—
limit	query	integer	—
cursor	query	string	—

Responses

200A page of rows keyed by column name.

400Invalid filters or query shape.

401No valid bearer token.

403Missing database:read scope, or the plan lacks API access.

404Database not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<object>	—
count*	—	integer	—
next_cursor*	—	string \| null	—

Example response

json

{
  "data": [
    {
      "id": "row_01HXEXAMPLE",
      "Name": "Ada Lovelace",
      "Status": "active",
      "createdAt": 1719792000000,
      "updatedAt": 1719792000000
    }
  ],
  "count": 3,
  "next_cursor": null
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/databases/db_01HXEXAMPLE/rows \
  -H "Authorization: Bearer wextl_..."

Structures

4endpoints

GET/structuresAuth required

List the organization's structures.

Parameters

Name	In	Type	Description
limit	query	integer	—

Responses

200Structure summaries.

401No valid bearer token.

403Missing structure:read scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<StructureSummary>	—
truncated*	—	boolean	—

data[] item (StructureSummary)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
fieldCount*	—	integer	—

Example response

json

{
  "data": [
    {
      "id": "abc123",
      "name": "My workflow",
      "fieldCount": 3
    }
  ],
  "truncated": true
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/structures \
  -H "Authorization: Bearer wextl_..."

POST/structuresAuth required

Create a structure. Honours the structures_created plan limit (no bypass).

Request body (required)

Name	In	Type	Description
name*	body	string	—
description	body	string	—
fields	body	array<StructureField>	—
folderId	body	string \| null	—
teamId	body	string \| null	—

Responses

201Created structure.

400Invalid body.

401No valid bearer token.

403Missing structure:write scope, or plan structure limit reached.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	Structure	—

data shape (Structure)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
fields*	—	array<object>	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "fields": [
      {
        "name": "My workflow",
        "type": "action",
        "required": true
      }
    ]
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/structures \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My workflow",
  "description": "...",
  "fields": [
    {
      "name": "email",
      "type": "text",
      "required": true
    }
  ],
  "folderId": "fld_01HXEXAMPLE",
  "teamId": "team_01HXEXAMPLE"
}'

GET/structures/{id}Auth required

Read one structure's field list.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200Structure fields.

401No valid bearer token.

403Missing structure:read scope, or the plan lacks API access.

404Structure not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	Structure	—

data shape (Structure)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
fields*	—	array<object>	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "fields": [
      {
        "name": "My workflow",
        "type": "action",
        "required": true
      }
    ]
  }
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/structures/struct_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

PATCH/structures/{id}Auth required

Update a structure name, description, fields, or folderId.

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
name	body	string	—
description	body	string	—
fields	body	array<StructureField>	—
folderId	body	string \| null	—

Responses

200Updated structure.

400Invalid body.

401No valid bearer token.

403Missing structure:write scope.

404Structure not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	Structure	—

data shape (Structure)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
fields*	—	array<object>	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "fields": [
      {
        "name": "My workflow",
        "type": "action",
        "required": true
      }
    ]
  }
}

Example request

bash

curl -X PATCH https://eu1.wextl.com/api/v1/structures/struct_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My workflow",
  "description": "...",
  "fields": [
    {
      "name": "email",
      "type": "text",
      "required": true
    }
  ],
  "folderId": "fld_01HXEXAMPLE"
}'

Functions

4endpoints

GET/functionsAuth required

List the organization's custom functions (metadata only).

Parameters

Name	In	Type	Description
cursor	query	string	—
limit	query	integer	—
q	query	string	—

Responses

200Function summaries.

401No valid bearer token.

403Missing function:read scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<FunctionSummary>	—
next_cursor*	—	string \| null	—

data[] item (FunctionSummary)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
description	—	string \| null	—

Example response

json

{
  "data": [
    {
      "id": "abc123",
      "name": "My workflow",
      "description": "..."
    }
  ],
  "next_cursor": null
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/functions \
  -H "Authorization: Bearer wextl_..."

POST/functionsAuth required

Create a custom function. Requires the custom_functions plan feature (no bypass).

Request body (required)

Name	In	Type	Description
name*	body	string	camelCase name.
code*	body	string	—
description	body	string	—
parameters	body	array<FunctionParameter>	—
folderId	body	string \| null	—
teamId	body	string \| null	—

Responses

201Created function.

400Invalid body.

401No valid bearer token.

403Missing function:write scope, or custom_functions not on plan.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	Function	—

data shape (Function)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
description	—	string \| null	—
code*	—	string	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "code": "...",
    "description": "..."
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/functions \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My workflow",
  "code": "...",
  "description": "...",
  "parameters": [
    {
      "name": "amount",
      "type": "number",
      "description": "Order total in cents.",
      "required": true
    }
  ],
  "folderId": "fld_01HXEXAMPLE",
  "teamId": "team_01HXEXAMPLE"
}'

GET/functions/{id}Auth required

Read one custom function including user-owned code.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200Function with code.

401No valid bearer token.

403Missing function:read scope, or the plan lacks API access.

404Function not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	Function	—

data shape (Function)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
description	—	string \| null	—
code*	—	string	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "code": "...",
    "description": "..."
  }
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/functions/fn_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

PATCH/functions/{id}Auth required

Update a custom function. Requires the custom_functions plan feature (no bypass).

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
name	body	string	—
code	body	string	—
description	body	string	—
parameters	body	array<FunctionParameter>	—
folderId	body	string \| null	—

Responses

200Updated function.

400Invalid body.

401No valid bearer token.

403Missing function:write scope, or custom_functions not on plan.

404Function not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	Function	—

data shape (Function)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
description	—	string \| null	—
code*	—	string	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "code": "...",
    "description": "..."
  }
}

Example request

bash

curl -X PATCH https://eu1.wextl.com/api/v1/functions/fn_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My workflow",
  "code": "...",
  "description": "...",
  "parameters": [
    {
      "name": "amount",
      "type": "number",
      "description": "Order total in cents.",
      "required": true
    }
  ],
  "folderId": "fld_01HXEXAMPLE"
}'

Teams

1endpoint

GET/teamsAuth required

List the organization's teams (discovery for create_workflow; requires workflow:read).

Responses

200Team summaries.

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<Team>	—

data[] item (Team)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
createdAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": [
    {
      "id": "abc123",
      "name": "My workflow",
      "createdAt": 1719792000000
    }
  ]
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/teams \
  -H "Authorization: Bearer wextl_..."

Folders

4endpoints

GET/foldersAuth required

List the organization's folder tree (discovery for create_workflow; requires workflow:read).

Responses

200Folder summaries.

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<Folder>	—

data[] item (Folder)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
parentId*	—	string \| null	—

Example response

json

{
  "data": [
    {
      "id": "abc123",
      "name": "My workflow",
      "parentId": "abc123"
    }
  ]
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/folders \
  -H "Authorization: Bearer wextl_..."

POST/foldersAuth required

Create a folder (requires workflow:write).

Request body (required)

Name	In	Type	Description
name*	body	string	—
parentId	body	string \| null	—

Responses

201Created folder.

400Invalid name or parentId.

401No valid bearer token.

403Missing workflow:write scope.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	Folder	—

data shape (Folder)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
parentId*	—	string \| null	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "parentId": "abc123"
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/folders \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My workflow",
  "parentId": "abc123"
}'

PATCH/folders/{id}Auth required

Rename or reparent a folder (requires workflow:write).

Parameters

Name	In	Type	Description
id*	path	string	—

Request body (required)

Name	In	Type	Description
name	body	string	—
parentId	body	string \| null	—

Responses

200Updated folder.

400Invalid name or parentId.

401No valid bearer token.

403Missing workflow:write scope.

404Folder not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	Folder	—

data shape (Folder)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
parentId*	—	string \| null	—

Example response

json

{
  "data": {
    "id": "abc123",
    "name": "My workflow",
    "parentId": "abc123"
  }
}

Example request

bash

curl -X PATCH https://eu1.wextl.com/api/v1/folders/fld_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My workflow",
  "parentId": "abc123"
}'

DELETE/folders/{id}Auth required

Delete a folder (requires workflow:write). Contents are not cascade-deleted.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200Deleted.

401No valid bearer token.

403Missing workflow:write scope.

404Folder not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	object	—

data shape (object)

Name	In	Type	Description
ok	—	boolean	—

Example response

json

{
  "data": {
    "ok": true
  }
}

Example request

bash

curl -X DELETE https://eu1.wextl.com/api/v1/folders/fld_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

Activity

1endpoint

GET/activityAuth required

List the organization's activity feed (audit log). Requires activity:read (owner/admin).

Parameters

Name	In	Type	Description
targetType	query	string	—
targetId	query	string	—
actorUserId	query	string	—
action	query	string	—
since	query	integer	Epoch ms lower bound.
until	query	integer	Epoch ms upper bound (exclusive).
limit	query	integer	—
cursor	query	string	Opaque "{ts}_{id}" from a previous page.

Responses

200Activity page with labeled events and actor map.

401No valid bearer token.

403Missing activity:read scope, or not an org admin.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	ActivityPage	—

data shape (ActivityPage)

Name	In	Type	Description
events*	—	array<object>	—
actors*	—	object	actorUserId → actor, for every distinct actor referenced in events.
next_cursor*	—	string \| null	—

Example response

json

{
  "data": {
    "events": [
      {
        "id": "abc123",
        "ts": 0,
        "action": "...",
        "label": "My workflow",
        "targetType": "...",
        "targetId": "abc123",
        "actorUserId": "abc123",
        "metadata": "..."
      }
    ],
    "actors": {
      "usr_01HXEXAMPLE": {
        "id": "usr_01HXEXAMPLE",
        "name": "Ada Lovelace",
        "email": "[email protected]"
      }
    },
    "next_cursor": null
  }
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/activity \
  -H "Authorization: Bearer wextl_..."

Invitations

3endpoints

GET/invitationsAuth required

List organization invitations. Requires invitation:read (owner/admin).

Parameters

Name	In	Type	Description
status	query	string	—
limit	query	integer	—

Responses

200Invitation summaries (includes invite_url).

401No valid bearer token.

403Missing invitation:read scope, or not an org admin.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<Invitation>	—

data[] item (Invitation)

Name	In	Type	Description
id*	—	string	—
email*	—	string	—
role	—	string \| null	—
teamId	—	string \| null	—
status*	—	string	—
expiresAt*	—	integer	Epoch milliseconds.
createdAt*	—	integer	Epoch milliseconds.
inviterId*	—	string	—
invite_url*	—	string	Absolute URL for the invitee; relay if email delivery fails.

Example response

json

{
  "data": [
    {
      "id": "abc123",
      "email": "...",
      "status": "succeeded",
      "expiresAt": 1719792000000,
      "createdAt": 1719792000000,
      "inviterId": "abc123",
      "invite_url": "...",
      "role": "...",
      "teamId": "team_01HXEXAMPLE"
    }
  ]
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/invitations \
  -H "Authorization: Bearer wextl_..."

POST/invitationsAuth required

Create an invitation. Requires invitation:write. Returns invite_url for headless relay.

Request body (required)

Name	In	Type	Description
email*	body	string	—
role*	body	string	—
teamId	body	string \| null	—

Responses

201Created invitation.

401No valid bearer token.

403Missing invitation:write, seat cap, or role escalation denied.

409Pending invitation already exists for this email.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	Invitation	—

data shape (Invitation)

Name	In	Type	Description
id*	—	string	—
email*	—	string	—
role	—	string \| null	—
teamId	—	string \| null	—
status*	—	string	—
expiresAt*	—	integer	Epoch milliseconds.
createdAt*	—	integer	Epoch milliseconds.
inviterId*	—	string	—
invite_url*	—	string	Absolute URL for the invitee; relay if email delivery fails.

Example response

json

{
  "data": {
    "id": "abc123",
    "email": "...",
    "status": "succeeded",
    "expiresAt": 1719792000000,
    "createdAt": 1719792000000,
    "inviterId": "abc123",
    "invite_url": "...",
    "role": "...",
    "teamId": "team_01HXEXAMPLE"
  }
}

Example request

bash

curl -X POST https://eu1.wextl.com/api/v1/invitations \
  -H "Authorization: Bearer wextl_..." \
  -H "Content-Type: application/json" \
  -d '{
  "email": "...",
  "role": "...",
  "teamId": "team_01HXEXAMPLE"
}'

DELETE/invitations/{id}Auth required

Cancel a pending invitation. Requires invitation:write.

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200Cancelled.

401No valid bearer token.

403Missing invitation:write scope, or not an org admin.

404Invitation not found.

409Invitation is not pending.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	object	—

data shape (object)

Name	In	Type	Description
ok	—	boolean	—

Example response

json

{
  "data": {
    "ok": true
  }
}

Example request

bash

curl -X DELETE https://eu1.wextl.com/api/v1/invitations/inv_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

Webhooks

2endpoints

GET/webhooksAuth required

List inbound webhooks (requires workflow:read).

Parameters

Name	In	Type	Description
cursor	query	string	—
limit	query	integer	—
q	query	string	—

Responses

200Webhook page.

401No valid bearer token.

403Missing workflow:read scope.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<WebhookSummary>	—
next_cursor*	—	string \| null	—

data[] item (WebhookSummary)

Name	In	Type	Description
id*	—	string	—
name*	—	string	—
url*	—	string	—
enabled*	—	boolean	—
method*	—	string	—
workflowId*	—	string \| null	—
nodeId*	—	string \| null	—
createdAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": [
    {
      "id": "wh_01HXEXAMPLE",
      "name": "Webhook",
      "url": "https://eu1.wextl.com/hooks/wh_01HXEXAMPLE",
      "enabled": true,
      "method": "POST",
      "workflowId": "wf_01HXEXAMPLE",
      "nodeId": "12",
      "createdAt": 1719792000000
    }
  ],
  "next_cursor": null
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/webhooks \
  -H "Authorization: Bearer wextl_..."

DELETE/webhooks/{id}Auth required

Delete a webhook. Pass force=1 if still bound to a workflow.

Parameters

Name	In	Type	Description
id*	path	string	—
force	query	string	—

Responses

204Deleted.

401No valid bearer token.

403Missing workflow:write scope.

404Webhook not found.

409Webhook in use — pass force=1.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Example request

bash

curl -X DELETE https://eu1.wextl.com/api/v1/webhooks/wh_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."

Members

1endpoint

GET/membersAuth required

List organization members, bounded and cursor-paginated (requires invitation:read / owner-admin).

Parameters

Name	In	Type	Description
cursor	query	string	Opaque continuation token from a previous response.
limit	query	integer	Page size. Default 100.

Responses

200A page of the member roster.

401No valid bearer token.

403Missing invitation:read scope, or not an org admin.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data*	—	array<Member>	—
next_cursor*	—	string \| null	—

data[] item (Member)

Name	In	Type	Description
userId*	—	string	—
email*	—	string \| null	—
name*	—	string \| null	—
role*	—	string	—
createdAt*	—	integer	Epoch milliseconds.

Example response

json

{
  "data": [
    {
      "userId": "usr_01HXEXAMPLE",
      "email": "[email protected]",
      "name": "Ada Lovelace",
      "role": "admin",
      "createdAt": 1719792000000
    }
  ],
  "next_cursor": null
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/members \
  -H "Authorization: Bearer wextl_..."

Catalog

3endpoints

GET/catalog/appsAuth required

Search the app and module catalog by keyword. Use the returned app and module ids when creating or updating workflow nodes.

Parameters

Name	In	Type	Description
query*	query	string	Search keywords (app or capability name).
limit	query	integer	Max apps to return. Default 10.

Responses

200Matching apps with their modules.

400query is required.

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	array<CatalogApp>	—

data[] item (CatalogApp)

Name	In	Type	Description
appId*	—	string	—
name*	—	string	—
description	—	string \| null	—
modules*	—	array<object>	—

Example response

json

{
  "data": [
    {
      "appId": "slack",
      "name": "My workflow",
      "modules": [
        {
          "id": "abc123",
          "label": "My workflow",
          "type": "action"
        }
      ],
      "description": "..."
    }
  ]
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/catalog/apps \
  -H "Authorization: Bearer wextl_..."

GET/catalog/apps/{appId}/modules/{moduleId}Auth required

Read a module's parameter schema and metadata. Does not expose internal request implementation details.

Parameters

Name	In	Type	Description
appId*	path	string	—
moduleId*	path	string	—

Responses

200The module spec (lean projection — meta + mappable/static fields).

400appId and moduleId are required, or the module cannot be projected for the public API.

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

404Module not found.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	ModuleSpec	—

data shape (ModuleSpec)

Name	In	Type	Description
meta*	—	object	Compact module metadata — label, description, which connection it needs, etc. Shape varies per module.
mappableFields*	—	array<object>	The fields the caller fills at run time (bindable to upstream data). Shape depends on the field type.
staticFields*	—	array<object>	Fixed UI-configuration params for this module — often empty. Shape depends on the field type.
emitsMultipleBundles	—	boolean	—
requiresConnection	—	boolean	—

Example response

json

{
  "data": {
    "meta": {
      "label": "Send a message",
      "description": "Post a message to a channel.",
      "connection": "oauth2"
    },
    "mappableFields": [
      {
        "name": "channel",
        "label": "Channel",
        "type": "select",
        "required": true
      }
    ],
    "staticFields": [
      {
        "name": "includeAttachments",
        "label": "Include attachments",
        "type": "boolean",
        "required": false
      }
    ],
    "emitsMultipleBundles": true,
    "requiresConnection": true
  }
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/catalog/apps/slack/modules/send_message \
  -H "Authorization: Bearer wextl_..."

GET/catalog/nodes/{kind}Auth required

Read the machine-readable spec for a NATIVE (built-in) workflow node kind — where its data persists, the exact field shape, a copyable example, and its outgoing routes. App/module nodes are not covered here; use GET /catalog/apps/{appId}/modules/{moduleId} for those.

Parameters

Name	In	Type	Description
kind*	path	string	Native node kind, e.g. 'condition', 'splitter', 'wait', 'js_code'.

Responses

200The native node-kind spec.

401No valid bearer token.

403Missing workflow:read scope, or the plan lacks API access.

404Unknown kind — use search_catalog for app/module nodes.

421Wrong regional endpoint — follow error.base_url.

429Rate limited — retry after error.retry_after_s seconds.

Name	In	Type	Description
data	—	NodeSpec	—

data shape (NodeSpec)

Name	In	Type	Description
kind*	—	string	—
label*	—	string	—
description*	—	string	—
insertable*	—	boolean	True when this kind appears in the builder palette.
persists_under*	—	string	Where this kind's data lives on the node.
shape*	—	object	Field name -> { type, required, description }.
example*	—	object	A filled config/params object for this kind, ready to copy into update_config / update_params.
routes*	—	array<string>	Outgoing edge types this kind can emit, e.g. 'normal', 'error', 'fallback'.
expressionGrammar*	—	string	How to reference upstream values inside wire strings.
edgeModel*	—	string	Edge topology notes — how to wire this kind's outgoing/incoming edges.

Example response

json

{
  "data": {
    "kind": "condition",
    "label": "Condition",
    "description": "Branches execution based on a boolean expression.",
    "insertable": true,
    "persists_under": "config",
    "shape": {
      "conditions": {
        "type": "array",
        "required": true,
        "description": "Ordered list of condition branches."
      }
    },
    "example": {
      "conditions": [
        {
          "expression": "{{1.status}} == \"ok\"",
          "label": "OK"
        }
      ]
    },
    "routes": [
      "normal"
    ],
    "expressionGrammar": "{{nodeId.path}} references an upstream node's output.",
    "edgeModel": "Each condition branch has its own outgoing port, in the order listed."
  }
}

Example request

bash

curl -X GET https://eu1.wextl.com/api/v1/catalog/nodes/id_01HXEXAMPLE \
  -H "Authorization: Bearer wextl_..."