Skyvern: Replay a run webhook

Skyvern runs.retryRunWebhook: arguments, response, policy and SDK examples.

Operation skyvern.retry_run_webhook_v1_runs_run_id_retry_webhook_post

Provider route: POST /v1/runs/{run_id}/retry_webhook. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";

async function execute(input: Parameters<SkyvernIntegration["runs"]["retryRunWebhook"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.runs.retryRunWebhook(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.runs.retry_run_webhook(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.run_id`	string	Required within parent	The id of the task run or the workflow run.
`body`	JSON	Optional
`body (anyOf 1)`	Model	Alternative	Expand Replay a run webhook — request body — body webhook url
`body (anyOf 2)`	null	Alternative

Referenced models: Replay a run webhook — request body — body webhook url

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 Replay a run webhook — response body

Referenced models: Replay a run webhook — response body

Schemas

Replay a run webhook — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`default_webhook_url`	JSON	Optional	Webhook URL stored on the original run configuration
`default_webhook_url (anyOf 1)`	string	Alternative
`default_webhook_url (anyOf 2)`	null	Alternative
`error`	JSON	Optional	Error message if the replay attempt failed
`error (anyOf 1)`	string	Alternative
`error (anyOf 2)`	null	Alternative
`headers`	object	Required within parent	Signed headers that were generated for the replay attempt Additional keys: see wildcard field
`headers.*`	string	Additional keys
`latency_ms`	JSON	Optional	Round-trip latency in milliseconds for the replay attempt
`latency_ms (anyOf 1)`	JSON	Alternative
`latency_ms (anyOf 1) (anyOf 1)`	integer	Alternative
`latency_ms (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`latency_ms (anyOf 2)`	null	Alternative
`payload`	string	Required within parent	JSON payload that was delivered during the replay attempt
`response_body`	JSON	Optional	Body returned by the webhook receiver (truncated to 2KB)
`response_body (anyOf 1)`	string	Alternative
`response_body (anyOf 2)`	null	Alternative
`run_id`	string	Required within parent	Identifier of the run that was replayed
`run_type`	string	Required within parent	Run type associated with the payload
`status_code`	JSON	Optional	HTTP status code returned by the webhook receiver, if available
`status_code (anyOf 1)`	JSON	Alternative
`status_code (anyOf 1) (anyOf 1)`	integer	Alternative
`status_code (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`status_code (anyOf 2)`	null	Alternative
`target_webhook_url`	JSON	Optional	Webhook URL that the replay attempted to reach
`target_webhook_url (anyOf 1)`	string	Alternative
`target_webhook_url (anyOf 2)`	null	Alternative

Replay a run webhook — request body — body webhook url

Field	Type	Presence	Description and constraints
`$`	object	Root
`webhook_url`	JSON	Optional	Optional webhook URL to send the payload to instead of the stored configuration
`webhook_url (anyOf 1)`	string	Alternative
`webhook_url (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: skyvern.retry_run_webhook_v1_runs_run_id_retry_webhook_post. Catalog operation: retry_run_webhook_v1_runs__run_id__retry_webhook_post. 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.

Official provider source

Report an issue with this page