Term Definitions
Alert: An event that occurred during a mission. Examples include failure to takeoff and subject detection.
Mission Result: Outcome of Mission that generated Alert, if alert_type is MISSION_INCOMPLETE. See Mission Results for a detailed list of possible values.
Webhook: Real-time data sent when an event occurs.
Webhook Url: The url which the webhook data is sent to.
Alert: A notification that triggers upon certain events.
Org-wide Alert: A notification that triggers when certain events occur on any device in the organization.
Alert Target: A device that will cause the alert to trigger when certain events occur on that specific device.
Alert Types
| Alert Type | Description |
|---|---|
| HUMAN_DETECTED | A human was detected |
| MISSION_INCOMPLETE | Mission was interrupted and did not successfully complete all actions |
| DOCK_ERROR | Error occurred |
| SCHEDULED_MISSION_FAILED_TAKEOFF | Scheduled mission failed to launch |
| FLIGHT_STATUS | Flight started or ended |
| WAYPOINT_PROGRESS | Vehicle progressed through a mission waypoint |
| ONLINE_STATUS | Device became online or offline |
| MEDIA_FILE_AVAILABLE | Flight media file successfully uploaded |
| MEDIA_AVAILABLE_FOR_SCAN | All media files for a scan successfully uploaded |
| TELEMETRY_AVAILABLE | Flight telemetry log is available |
| LIVE_STREAM_STATUS_CHANGED | Live Stream started or ended |
| MEDIA_AVAILABLE_FOR_FLIGHT | All media files for a flight successfully uploaded |
Example code
These samples use our example Python client
View any alerts fired by a vehicle
alert_resp = client.get("/v0/alerts_history", params={"vehicle_serial": "Skydio2-1234"})