API Reference

Execute a dashboard action widget

POST /api/dashboards/{id}/widgets/{widgetId}/action

Validates form values against the action widget schema, evaluates arguments_expr/args, then dispatches run_task, job_run, or connector_method. Creates a dashboard_action_runs audit row. In-flight and cooldown checks apply per dashboard+widget. Open to any authenticated user.

Operation IDexecuteDashboardAction

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

widgetIdstringrequired

Request body

Content typeapplication/json

requestobject

2 properties

formobject

Form field values keyed by field key (validated against the action widget's form schema).

Additional properties are allowed.

rowobject

Optional row context (e.g. from a field_mapping row_action) merged into arguments_expr.

Additional properties are allowed.

Success response body

201Action accepted

Action accepted

Content typeapplication/json

responseobject

3 properties

action_run_idintegerrequired

run_idinteger

Present when kind is run_task

job_run_idinteger

Present when kind is job_run

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

409In-flight action or cooldown

In-flight action or cooldown

No response content schema is documented.

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/dashboards/YOUR_ID/widgets/YOUR_WIDGET_ID/action' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "form": {},
  "row": {}
}'

const response = await fetch("https://your-envoy.example.com/api/dashboards/YOUR_ID/widgets/YOUR_WIDGET_ID/action", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "form": {},
    "row": {}
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);