SKskydio
Alerts

Get Alerts

Changed on

Search alert by various parameters.

get/v0/alerts

Request

  • Base URL
    https://api.skydio.com/api
  • Auth
    API key in header Authorization

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' | 'MEDIA_AVAILABLE_FOR_FLIGHT' | 'OPERATION_EVENT' | 'OBSERVATION' | 'AUTODETECTION'

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

Changes

  • 6589167ebe70Revision changes
    • warning

      added the new AUTODETECTION enum value to the //// response property for the response status

    • warning

      added the new MEDIA_AVAILABLE_FOR_FLIGHT enum value to the //// response property for the response status

    • warning

      added the new OBSERVATION enum value to the //// response property for the response status

    • warning

      added the new OPERATION_EVENT enum value to the //// response property for the response status

    • info

      added the new enum value AUTODETECTION to the query request parameter event_type

    • info

      added the new enum value MEDIA_AVAILABLE_FOR_FLIGHT to the query request parameter event_type

    • info

      added the new enum value OBSERVATION to the query request parameter event_type

    • info

      added the new enum value OPERATION_EVENT to the query request parameter event_type