FLflightaware
alerts

Create new alert

Create a new AeroAPI flight alert. When the alert is triggered, a callback mechanism will be used to notify the address set via the /alerts/endpoint endpoint. Each callback will be charged as a query and count towards usage for the AeroAPI key that created the alert. If this key is disabled or removed, the alert will no longer be available. If a target_url is provided, then this specific alert will be delivered to that address regardless of the adress set via the /alerts/endpoint endpoint.

post/alerts

Request

Request body

identstring nullable required

Ident to alert on. This value may be modified based on codeshare resolution. If that occurs, the originally provided ident will be preserved in the user_ident field.

originstring nullable required

Origin airport ICAO, IATA, or LID code to alert on.

destinationstring nullable required

Destination airport ICAO, IATA, or LID code to alert on.

aircraft_typestring nullable required

Aircraft type ICAO code to alert on.

startstring date nullable required

Start date of alert. Should be in departure airport's timezone.

endstring date nullable required

End date of alert (inclusive). Should be in departure airport's timezone.

max_weeklyinteger

Reject the new alert if the estimated number of triggered alerts per week based on historical flight trends would exceed this value. The threshold only considers alerts triggered by this alert config (it is not a total for all previously configured alerts). Check is only applied at alert creation/modification, and does and does not prevent alerts from being delivered even if they exceed the given amount. If your alert request is rejected, consider adding additional filter criteria for the alert creation to further refine the config. If max_weekly is not specified for a standard customer, we default the max_weekly to 1000. For a premium customer, we default the max_weekly to 4000.

etainteger required

How many minutes before a flight's ETA that an alert should be delivered. Alerts will only be delivered after the flight has been in the air for at least 15 minutes. Set to 0 to disable.

target_urlstring nullable required

Alert specific URL to deliver to. If null, then the alert will be delivered to the configured account-wide alert URL target.

Response

Alert created successfully

Changes

No recorded changes to this operation across all 1 revision of this API.