Webhooks FAQ
How Skyvern notifies you when its done
Webhooks vs HTTP requests?
Task runtimes can exceed default HTTP timeouts; we recommend using webhook notifications to inform you when the run is complete.
To set up webhook callback:
- Set webhook_url in Run Task to receive the update when the task is done.
- Set webhook_url in Run Workflow to receive the update when a workflow run is done.
To fetch the status of a run:
- Use the Get Run endpoint for the status of a task or workflow run
Webhook payload schema
The webhook request body is a JSON object with the following fields:
For detailed schema, please refer to the Run Response.
Notes:
- The webhook payload won’t contain the
run_request
field as the Run Response does. - There are legacy fields in the actual payload for backward compatibility, which are not listed here and will be removed in the future. Please use the fields above.
How do we handle webhook authentication? (ie how can we handle callbacks?)
Can I Replay Webhook?
Yes, you can replay a webhook by using the Retry Webhook endpoint.