workflow

Call workflow.invoke

Run one explicitly enrolled managed automation through to its result — 'run the lead workflow now', 'send this form through the enrolment automation'. It waits for the run's terminal result. Not for checking on a run already started — that is workflow.api_status.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with workspace_ambiguous and lists the choices — offer them, never pick one.

post/api/v1/tools/workflow.invoke

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/workflow.invoke
  • Auth: HTTP bearer

Headers

x-request-idstring

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Idempotency-Keystring

Your key for this write: send the same key when you retry and the first result comes back instead of a second action. Keys are honoured for at least 24 hours. 1–200 visible ASCII characters. Replaces the idempotency_key body field, which still works until 2026-12-31.

Request body

enrollmentIdstring uuid

The active managed workflow enrollment to invoke at its pinned version.

inputobject

The workflow input object; omit it when no input is needed.

confirmation_idstring uuid

Confirms the stored exact call. When supplied, the stored request replaces all other body fields.

idempotency_keystring

Deprecated on REST: send the Idempotency-Key header instead. Still accepted until 2026-12-31; if both are sent they must match.

workspacestring

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

OR

Changes

No recorded changes to this operation across all 4 revisions of this API.