Overview
Owloops Runner provides a WebSocket endpoint to interact with the system in real time.
Connection to WebSocket
using wscat
wscat -c "wss://runner.dev.owloops.link?api_key=<your_api_key>"
Replace <your_api_key> with your actual API key.
Message Format
{
"action": "flybird",
"birdOrigin": "ws",
"birdId": "2605a0a8-b6c8-4037-ac9b-c4f756149e44",
"api_key": "key-1234567890"
}
| Parameter | Description |
|---|---|
| action | should be set to flybird to invoke the WebSocket API |
| birdOrigin | can be any string to identify the origin of the execution |
| birdId | Id of your bird can be retrieved from the bird view URL |
| api_key | Your api_key with bird.runscope to allow running the bird |
Bird Settings
The Owloops Runner uses the existing bird settings for the specified bird. Such settings are:
| Setting | Description |
|---|---|
| Webhook URL | Send results to specified webhook URL |
| On Error | Send failed results to specified webhook URL |
| Proxy | Use a proxy server to perform browser interactions from |
| Email Notifications | Get notified via email in case of any errors during scheduled runs |
| Speed | Speed of the bird (normal, slow, very slow, extremely slow) |
| Schedule | Schedule frequency of the bird (5m - 24h) |