AeroAPI Webhook

Hello

What is the method (POST?), content type (XML or JSON) and the payload structure which should be accepted by the webhook endpoint?

Thank you!

Dorian

Hi crapufish,

Both formats may be used for the webhook endpoint.

Below is an example XML payload:

<alert>
  <faFlightID>UAL1234-1706918400-airline-0123</faFlightID>
  <ident>UAL1234</ident>
  <aircrafttype>B738</aircrafttype>
  <origin>
    <code>KORD</code>
    <city>Chicago, IL</city>
    <airport_name>O'Hare Intl</airport_name>
  </origin>
  <destination>
    <code>KDEN</code>
    <city>Denver, CO</city>
    <airport_name>Denver Intl</airport_name>
  </destination>
  <eventcode>departure</eventcode>
  <timestamp>2026-02-01T15:02:10Z</timestamp>
  <departure_time>
    <scheduled>2026-02-01T15:00:00Z</scheduled>
    <actual>2026-02-01T15:02:06Z</actual>
  </departure_time>
  <status>En Route</status>
</alert>

When creating a JSON payload, you’d pass format=xml when creating the rule:

https://aeroapi.flightaware.com/aeroapi/alerts/create?format=xml

With a POST body like:

{
  "alert_name": "UAL Departures",
  "type": "webhook",
  "url": "https://yourserver.com/aeroapi/webhook",
  "channels": ["webhook"],
  "ident": "UAL1234"
}