v1

latestOpenAPI 3.1.02026-07-26650239.3 KB
Alerts

Get Alerts

Search alert by various parameters.

get/v0/alerts

Query parameters

search_termstring

Search term to filter alert configs by name

user_emailstring

Filter by user email for alert notification (deprecated, use recipient_search_term instead)

webhook_idstring uuid

Filter by webhook ID for alert notifications

event_type'HUMAN_DETECTED' | 'MISSION_INCOMPLETE' | 'DOCK_ERROR' | 'SCHEDULED_MISSION_FAILED_TAKEOFF' | 'FLIGHT_STATUS' | 'ONLINE_STATUS' | 'MEDIA_FILE_AVAILABLE' | 'MEDIA_AVAILABLE_FOR_SCAN' | 'TELEMETRY_AVAILABLE' | 'WAYPOINT_PROGRESS' | 'LIVE_STREAM_STATUS_CHANGED'

Type of event that triggers the alert

recipient_search_termstring

Search term to filter by recipient name, email or phone

per_pageinteger

Number of results to return per page

page_numberinteger

Return a specific page number from results

Response

List of alerts configurations returned from GET /alerts endpoint

error_messagestring
skydio_error_codeinteger required
status_codeinteger required