Runs

Replay a run webhook

Retry sending the webhook for a run

post/v1/runs/{run_id}/retry_webhook

Path parameters

run_idstring required

The id of the task run or the workflow run.

Example:tsk_123

The id of the task run or the workflow run.

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Request body

webhook_urlstring nullable

Optional webhook URL to send the payload to instead of the stored configuration

Response

Successful Response

run_idstring required

Identifier of the run that was replayed

run_typestring required

Run type associated with the payload

default_webhook_urlstring nullable

Webhook URL stored on the original run configuration

target_webhook_urlstring nullable

Webhook URL that the replay attempted to reach

payloadstring required

JSON payload that was delivered during the replay attempt

headersobject required

Signed headers that were generated for the replay attempt

status_codeinteger nullable

HTTP status code returned by the webhook receiver, if available

latency_msinteger nullable

Round-trip latency in milliseconds for the replay attempt

response_bodystring nullable

Body returned by the webhook receiver (truncated to 2KB)

errorstring nullable

Error message if the replay attempt failed

Changes

Changed in 3 of the 101 revisions of this API.3120

    • ○

      api tag Runs added

      api-tag-added

    • ○

      api tag Agents removed

      api-tag-removed

  • 3a3616091b663117See the full diff
    • ▲

      the request's body became not nullable

      request-body-became-not-nullable

    • ▲

      the request's body type changed from object to no type

      request-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ●

      removed the request property

      request-property-removed

    • ○

      api tag Agents added

      api-tag-added

    • ○

      api tag Agent removed

      api-tag-removed

    • ○

      added subschema #2 to the request body anyOf list

      request-body-any-of-added

    • ○

      header request parameter x-api-key list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      for the header request parameter x-api-key, the type was generalized from string to no type

      request-parameter-type-generalized

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog