automations

Call automations.test_run

'test this automation', 'dry-run it before we switch it on' — dry-run one automation in this workspace, named by its board_id, against the workspace's synthetic test contact: its draft (or, with no draft, the version that runs) walks every step, sends go only to the workspace's designated test address, waits are skipped and CRM writes are withheld. A person or deal the member names is the test to run: the synthetic test contact stands in for them, and the answer's subject says so. The run starts with the trigger data a real start carries for that contact; sample carries only trigger details the member gave (a form's fields, say), as test values. A run uses model and step time. It answers in two calls: without confirmation_id it proposes, names the version and the test address and runs nothing; the same call again with that confirmation_id, on a member's own API key, runs it. Not for switching it on for real contacts — that is automations.activate.

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.test_run

Request

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

The id of the automation to test, as automations.list answers it — never its name. Omit it to test the automation this conversation is on; for another automation the operator names, read its board_id from automations.list and pass that.

sampleobject

Sample trigger data, shaped as a real trigger of this automation would carry it — for a form capture, { event: { payload: { fields: { form: "application" } } } }. Pass it only with trigger details the operator gave (a form they named, say), as test values; a plain test passes none. Any person in it is replaced by the synthetic test contact, which stands in for them. A JSON object, at most 16 KB.

confirmation_idstring uuid

Omit to propose: the first call says what would happen, returns a confirmation_id and changes nothing. To go ahead, send the same arguments again with that confirmation_id, on a member's own API key; a service account's key can propose but never confirm.

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 6 revisions of this API.