GoRunner docs
Search or askSearch⌘K

Review what publishing changes

Since v2026.10.8

GET/api/workflows/{id}/publish-review

Shows what publishing the draft would put live, compared with the last version a person published.

Needs an API token with the Read permission for workflows (workflow:read).

Parameters

Path

idRequired · UUID

The workflow’s ID.

Read it

diff lists the changes. callouts names each step that holds or reads a secret, a connection or an address, and where it sends it: names only, never a value. outline is the tree that would go live, with every setting emptied.

It is the review on Keel’s publish card, worked out the same way. Versions Keel published on its own are passed over. firstPublish is true when no person has published yet.

Responses

  • 200OK

    The review.

  • id isn’t a UUID.

  • The token lacks the Read permission for workflows.

  • No workflow with this ID in the token’s workspace.

  • The draft or a version couldn’t be read. Try again.

Any call can also answer: 401 UNAUTHORIZED · 401 TOKEN_ENDED · 403 TOKEN_SURFACE_OFF · 403 FEATURE_OFF · 403 EMBED_NOT_ALLOWED · 403 EMBED_NOT_AVAILABLE · 403 ACCOUNT_SUSPENDED · 429 RATE_LIMITED · 503 BUSY · 503 PAUSED · 503 SERVICE_UNAVAILABLE. See Errors.

Request

GORUNNER="https://api.gorunner.io"
GORUNNER_TOKEN="grt_…"  # needs Read for workflows
WORKFLOW_ID="your-workflow-id"

URL="$GORUNNER/api/workflows/$WORKFLOW_ID/"
URL="${URL}publish-review"
curl "$URL" \
  -H "Authorization: Bearer $GORUNNER_TOKEN"

Response · 200 OK, shortened

json
{
  "data": {
    "rev": 8,
    "baseVersionId": "f20f671a-2c8e-4b9d-a7f1-6e3b0d5c9a12",
    "baseVersion": 3,
    "firstPublish": false,
    "diff": [
      {
        "kind": "add",
        "text": "Add step “Post to Slack”"
      }
    ],
    "callouts": [
      {
        "kind": "connection",
        "step": "Post to Slack",
        "text": "Post to Slack will sign in with the connection “Slack (Acme)”"
      }
    ],
    "outline": {}
  }
}
Every field

It takes no body.

Response · 200 OK

dataobject

What publishing would put live (GET /api/workflows/{id}/publish-review).

revinteger

The draft revision the review describes; a publish click names it.

baseVersionIdUUID

The last version a person published; absent on a first publish.

baseVersioninteger

That version’s number.

firstPublishboolean

Nothing was published by a person before.

diffarray of objects
kindstring
textstring
calloutsarray of objects
kindstring

address | connection | secret

stepstring
textstring
outlineobject

The definition that goes live, every config emptied.