Workflows

Retrieve a workflow's step graph

Every step in the workflow, including its TRIGGER entry node, and every directed transition between them. version is the workflow's version at the time of the read — a different number on a later read means somebody edited the graph in between.

A step's config is returned exactly as stored, camelCase keys and all, rather than projected into the snake_case used everywhere else on this API. That is deliberate: the same document is authored by the visual editor, and renaming its keys on the way out would mean any key this API did not know about was silently dropped on the way back in.

The response of GET /api/v1/workflows/{id}/graph is accepted verbatim by PUT on the same path: read a graph, change a step, send it back. Step and transition ids are yours to choose on a write, which is what makes that round trip a no-op rather than a rebuild.

Requires the workflows:read scope — View your automation workflows and their runs.

get/api/v1/workflows/{id}/graph

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/workflows/{id}/graph
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: workflows:read)

Path parameters

idstring uuid required

Workflow id.

Response

The workflow's graph

versioninteger required

The workflow's version AFTER this read. Every structural change bumps it and writes a workflow_versions snapshot, so a changed number between two reads means somebody edited the graph.

workflow_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.