Rippling: Retrieve a workflow execution
Rippling restApi.getWorkflowExecution: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.get_workflow_execution
Provider route: GET /workflows/{id}/executions/{execution_id}/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["getWorkflowExecution"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.restApi.getWorkflowExecution(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.rest_api.get_workflow_execution(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.id | string | Required within parent | |
path.execution_id | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Execute a workflow — response body |
Referenced models: Execute a workflow — response body
Schemas
Section titled “Schemas”Execute a workflow — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single execution of a workflow: one launch of the workflow's current published version, with a status to poll until it reaches a terminal value. Additional keys: not allowed |
created_at | string | Required within parent | When the workflow was launched, in UTC (ISO 8601). Format: date-time |
id | string | Required within parent | Unique identifier for this workflow execution. Poll it with GET /workflows/{id}/executions/{execution_id}. |
status | string | Required within parent | The execution status. Transitional values are `pending`, `in_progress`, `waiting_for_response`, and `cancellation_pending`; terminal values are `completed`, `failed`, and `cancelled`. Poll until the status reaches a terminal value. * `pending`: The execution is queued and has not started. * `in_progress`: The workflow is executing. * `waiting_for_response`: The execution is paused on a human input or approval step. * `cancellation_pending`: A cancellation was requested and is being applied. * `completed`: Every step finished successfully. * `failed`: The execution stopped on an error. * `cancelled`: The execution was cancelled before completing. * `unknown`: The status could not be mapped. Contact support if this persists. Known values: pending, in_progress, completed, failed, cancelled, cancellation_pending, waiting_for_response, unknown |
version_id | string | Required within parent | The workflow version that ran. An execution always runs the workflow's current published version; the current version_id is available from GET /workflows/{id}. |
workflow_id | string | Required within parent | The ID of the workflow this execution belongs to. Matches the {id} path parameter. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.get_workflow_execution. Catalog operation: get-workflow-execution. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["workflow-executions.read", "workflow-executions.read-write"]
Provider entitlements: ["API_Tier_1"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}