Flight Alert API

Get web-hook subscription / FREE TIER

This endpoint is a part of Flight alert PUSH API currently powered by webhooks.
If you are running your own web service, you can subscribe to flights by number or airport code. After that, your HTTP endpoint will be called (notified) whenever the flight information gets updated.

Gets information about an existing active web-hook subscription.

get/subscriptions/webhook/{subscriptionId}

Request

  • Base URL: https://api.aerodatabox.com
  • URL: https://api.aerodatabox.com/subscriptions/webhook/{subscriptionId}
  • Auth: API key in header X-Api-Key

Path parameters

subscriptionIdstring uuid required

Subscription ID

Response

OK

idstring uuid required

Identifier of a subscription. Use this ID to control the subscription in future (e.g. update or delete).

isActiveboolean required

Specifies if the subscription is active

billingType'LifetimeBased' | 'CreditBased'

Flight alert subscription billing type<p>Possible values:</p>

<ul> <li><b>0 - LifetimeBased</b>: Subscription billed upon creation based on the life-time with set expiration date-time (BEING DEPRECATED)</li> <li><b>1 - CreditBased</b>: Subscription with no expiration date, billed based on the amount of notifications sent</li> </ul>
activateBeforeUtcstring date-time nullable

Time (UTC) before which subscription must be activated (may be applicable to some non-active newly created subscriptions)

expiresOnUtcstring date-time nullable

Time (UTC) when subscription expires and will be removed.

If not specified, subscription never expires.

createdOnUtcstring date-time required

Time (UTC) when subscription was created

noticesstring[] nullable

Additional messages

Changes

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