automations

Call automations.run

'run the welcome automation now', 'kick off the onboarding automation for this lead' — start a live run of one switched-on automation in this workspace, named by its board_id (automations.list gives each one): the same run its board's Run now starts, on the version that is live, so its sends and actions are real. It answers at once with the run id and pending; the run continues in the background and the automation's board shows how it went. Pass input to give the run its opening values, and a request_id of your own so a retried call answers the first run instead of starting a second. A draft or a switched-off automation is refused and nothing runs. Each run uses model and step time and is billed as a run. Not for trying a draft safely against the workspace's test contact — that is automations.test_run.

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/automations.run

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/automations.run
  • 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.

Request body

board_idstring uuid required

The automation's board id, as automations.list returns it in board_id.

inputobject

Optional values the run starts with, as one JSON object of at most 16 KB; its steps read them from the run's state. The run's own identity (tenant, workspace, user, run id) is set by the platform and cannot be supplied here.

request_idstring uuid

Optional UUID you choose for this start. Sending the same request_id again answers the first call's run and starts nothing new, so a retried call never runs the automation twice. Omit it and every call starts its own run.

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.