Skip to content
/
Update webhook subscripti...

FL3XX API (2.4.0)

FL3XX API v2.0 — Beta Release

Currently in active development with our trusted beta partners. Explore the next generation of aviation API capabilities.

BETA
Download OpenAPI description
index.json
index.yaml
Overview
URL
https://www.fl3xx.com
FL3XX Integration Support
integrations@fl3xx.com
License
MIT
Languages
Servers
Test Server
https://test.fl3xx.com/

Airports

Access comprehensive airport information.

Business Value

  • Filter airports by various criteria, including ICAO, IATA, FAA codes, and local identifiers
  • Support high‑performance applications with optimized data retrieval

Use Cases

  • Filter airports by specific codes for targeted data retrieval
  • Integrate airport data into flight‑planning and scheduling systems
  • Build airport‑selection interfaces with efficient pagination

Operations

Airport Fuel Prices

Manage and optimize airport‑fuel pricing data for your organization. These endpoints enable operators to efficiently update, remove, and bulk‑manage fuel prices, supporting streamlined fuel‑order workflows and provider management.

Business Value

  • Ensure accurate, up‑to‑date fuel pricing for all airport operations.
  • Reduce manual effort and errors by enabling bulk updates and deletions.
  • Support cost control and negotiation with providers through transparent pricing data.
  • Enhance operational planning and financial forecasting with reliable fuel‑cost data.

Use Cases

  • Update fuel prices for a specific airport to reflect new agreements or market changes.

  • Remove outdated or incorrect fuel prices for compliance and data integrity.

  • Perform bulk deletions to quickly adapt to network‑wide pricing changes.

  • Integrate with internal systems to automate fuel‑price management and reporting.


Note:

Data managed by the Airport Fuel Prices endpoints is strictly bound to the operator associated with the authentication token. All operations — creating, updating, or deleting airport fuel prices — apply only to the operator for which the provided token is valid.

Operations

Webhooks

Manage webhook subscriptions for near‑real‑time event notifications. These endpoints enable partners to create, manage, and monitor webhook subscriptions for receiving flight‑related events and updates.

Business Value

  • Receive near‑real‑time notifications for flight events and updates.
  • Automate integration workflows with external systems.
  • Monitor flight operations and passenger changes in near‑real‑time.
  • Reduce polling overhead by using event-driven architecture.

Use Cases

  • Subscribe to flight updates to sync data with external booking systems.
  • Monitor passenger‑count changes for catering and ground‑service coordination.
  • Track aircraft changes for maintenance and operational planning.
  • Receive notifications for flight cancellations and time updates.

Available Event Types:

Subscribable Event Types (can be used when creating webhook subscriptions):

  • FLIGHT_CREATE: New‑flight creation.
  • FLIGHT_CANCEL: Flight cancellation.
  • FLIGHT_TIME_UPDATE: Flight‑time changes.
  • FLIGHT_AIRCRAFT_UPDATE: Aircraft‑assignment changes.
  • FLIGHT_AIRPORT_UPDATE: Airport updates.
  • FLIGHT_POST_FLIGHT_STATUS: Post‑flight status updates.
  • FLIGHT_MOVEMENT_UPDATE: Flight‑movement updates.
  • FLIGHT_PAX_COUNT_UPDATE: Passenger‑count changes.
  • FLIGHT_PAX_LIST_UPDATE: Passenger‑list changes (for example, new passengers, updated lists, passenger‑document changes).
  • FLIGHT_PERMIT_ASSIGNMENT: Flight‑permit provider assignment.
  • FLIGHT_PERMIT_UNASSIGNMENT: Flight‑permit provider unassignment.
  • FLIGHT_SLOT_PPR_ASSIGNMENT: Flight‑slot-ppr provider assignment.
  • FLIGHT_SLOT_PPR_UNASSIGNMENT: Flight‑slot-ppr provider unassignment.

Group Event Types (not subscribable; appear in webhook deliveries when multiple events occur in a short period):

  • FLIGHT_UPDATE: Group event that combines multiple flight update events when they occur in a short period of time. Includes: FLIGHT_CREATE, FLIGHT_CANCEL, FLIGHT_TIME_UPDATE, FLIGHT_AIRCRAFT_UPDATE, FLIGHT_AIRPORT_UPDATE, FLIGHT_POST_FLIGHT_STATUS, FLIGHT_MOVEMENT_UPDATE, FLIGHT_PERMIT_UPDATE.
  • FLIGHT_PASSENGER_UPDATE: Group event that combines passenger-related events when they occur in a short period of time. Includes: FLIGHT_PAX_COUNT_UPDATE, FLIGHT_PAX_LIST_UPDATE.
  • FLIGHT_PERMIT_UPDATE: Group event that combines permit-related events when they occur in a short period of time. Includes: FLIGHT_PERMIT_ASSIGNMENT, FLIGHT_PERMIT_UNASSIGNMENT.
  • FLIGHT_SLOT_PPR_UPDATE: Group event that combines permit-related events when they occur in a short period of time. Includes: FLIGHT_SLOT_PPR_ASSIGNMENT, FLIGHT_SLOT_PPR_UNASSIGNMENT.

Note: Group event types (FLIGHT_UPDATE, FLIGHT_PASSENGER_UPDATE, FLIGHT_PERMIT_UPDATE) cannot be used when creating webhook subscriptions. They only appear in webhook delivery history when multiple individual events are triggered within a short time window and are grouped together for efficiency.


For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.

Important:

Webhook endpoints must respond within 1 second with a 200 status code. To avoid timeouts, we strongly recommend handling webhook processing on a different task/thread and immediately returning the response to FL3XX.

Operations

Get webhook subscription by ID

Request

Retrieves a specific webhook subscription by its unique identifier.

Features:

  • Returns detailed subscription information

For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.

Security
X-Api-Client-Id and X-Auth-Token
Path
subscriptionIdstringrequired

The unique identifier of the webhook subscription to retrieve.

Example: webhook-sub-12345
curl -i -X GET \
  https://test.fl3xx.com/api/v2/webhooks/subscriptions/webhook-sub-12345 \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Successfully retrieved webhook subscription

Bodyapplication/json
idstring

Unique identifier for the webhook subscription.

Example: "webhook-sub-12345"
eventstring

The event type that this subscription is listening for.

Example: "FLIGHT_UPDATE"
callbackUrlstring(uri)

The URL where webhook notifications will be sent.

Example: "https://example.com/webhooks"
statusstring(DbStatusType)

Status of the webhook subscription indicating whether it is active and receiving notifications or inactive.

Enum"ACTIVE""INACTIVE"
createdAtDateTimestring(date-time)

The date and time when the webhook subscription was created.

Example: "2024-01-15T10:30:00.000Z"
updatedAtDateTimestring(date-time)

The date and time when the webhook subscription was last updated.

Example: "2024-01-15T10:30:00.000Z"
expirationDateTimestring(date-time)

The date and time when the webhook subscription will expire.

Example: "2024-02-15T10:30:00.000Z"
Response
application/json
{
  "id": "webhook-sub-12345",
  "event": "FLIGHT_UPDATE",
  "callbackUrl": "https://example.com/webhooks",
  "status": "ACTIVE",
  "createdAtDateTime": "2024-01-15T10:30:00.000Z",
  "updatedAtDateTime": "2024-01-15T10:30:00.000Z",
  "expirationDateTime": "2024-02-15T10:30:00.000Z"
}

Update webhook subscription callback URL or status

Request

Updates the callback URL and/or the status (active or inactive) for an existing webhook subscription.

Features:

  • Validates the new callback URL format; only HTTPS is supported
  • Updates the subscription status to active or inactive

Example Use Case: An operations manager needs to change the webhook endpoint URL after migrating to a new server. Using this endpoint, they can update the callback URL without recreating the entire subscription.

For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.

Security
X-Api-Client-Id and X-Auth-Token
Path
subscriptionIdstringrequired

The unique identifier of the webhook subscription to update.

Example: webhook-sub-12345
Bodyapplication/jsonrequired
callbackUrlstring(uri)

The new URL where webhook notifications will be sent. Must be a valid HTTPS URL.

Example: "https://new-example.com/webhooks"
statusstring(DbStatusType)

Status of the webhook subscription indicating whether it is active and receiving notifications or inactive.

Enum"ACTIVE""INACTIVE"
curl -i -X PATCH \
  https://test.fl3xx.com/api/v2/webhooks/subscriptions/webhook-sub-12345 \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "callbackUrl": "https://new-example.com/webhooks",
    "status": "ACTIVE"
  }'

Responses

Successfully updated webhook subscription

Bodyapplication/json
idstring

Unique identifier for the webhook subscription.

Example: "webhook-sub-12345"
eventstring

The event type that this subscription is listening for.

Example: "FLIGHT_UPDATE"
callbackUrlstring(uri)

The URL where webhook notifications will be sent.

Example: "https://example.com/webhooks"
statusstring(DbStatusType)

Status of the webhook subscription indicating whether it is active and receiving notifications or inactive.

Enum"ACTIVE""INACTIVE"
createdAtDateTimestring(date-time)

The date and time when the webhook subscription was created.

Example: "2024-01-15T10:30:00.000Z"
updatedAtDateTimestring(date-time)

The date and time when the webhook subscription was last updated.

Example: "2024-01-15T10:30:00.000Z"
expirationDateTimestring(date-time)

The date and time when the webhook subscription will expire.

Example: "2024-02-15T10:30:00.000Z"
Response
application/json
{
  "id": "webhook-sub-12345",
  "event": "FLIGHT_UPDATE",
  "callbackUrl": "https://example.com/webhooks",
  "status": "ACTIVE",
  "createdAtDateTime": "2024-01-15T10:30:00.000Z",
  "updatedAtDateTime": "2024-01-15T10:30:00.000Z",
  "expirationDateTime": "2024-02-15T10:30:00.000Z"
}

Delete a webhook subscription

Request

Deletes a webhook subscription and stops receiving notifications for the associated event type.

Features:

  • Immediately stops webhook deliveries

Example Use Case: An operations manager needs to stop receiving flight update notifications after completing a system migration. Using this endpoint, they can cleanly remove the webhook subscription.

For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.

Security
X-Api-Client-Id and X-Auth-Token
Path
subscriptionIdstringrequired

The unique identifier of the webhook subscription to delete.

Example: webhook-sub-12345
curl -i -X DELETE \
  https://test.fl3xx.com/api/v2/webhooks/subscriptions/webhook-sub-12345 \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Successfully deleted webhook subscription

Crew Qualifications

Manage crew qualifications and certifications. These endpoints enable partners to assign, update, and manage crew‑member qualifications, including licenses, certifications, and associated documents.

Business Value

  • Maintain accurate crew qualification records for compliance and safety.
  • Streamline qualification assignment and management processes.
  • Support document management for qualification certificates and licenses.
  • Ensure crew members meet operational requirements and regulations.

Use Cases

  • Assign new qualifications to crew members with license details and expiration dates.
  • Update existing qualification information, including license numbers and issuing authorities.
  • Upload and manage qualification documents, such as certificates and licenses.
  • Retrieve qualification information for crew members and compliance reporting.
  • Delete obsolete qualifications and associated documents.

For more information on managing crew qualifications, see the Crew Qualification Management Guide.

Note:

All crew‑qualification operations are bound to the operator context associated with the authentication token. Partners can manage qualifications only for crew members within their own organization.

Operations

Flights

Access comprehensive flight information and data. These endpoints enable partners to retrieve flight details with advanced filtering and pagination.

Business Value

  • Retrieve flight data with flexible date‑range filtering.
  • Support high‑performance applications with optimized data retrieval and pagination.
  • Access essential flight information, including schedules, aircraft assignments, and passenger counts.

Use Cases

  • Retrieve flights within a specific date range for operational planning.
  • Integrate flight data into external systems for scheduling and logistics.
  • Monitor flight schedules and aircraft assignments in near‑real‑time.
  • Build flight‑tracking and reporting dashboards with paginated results.
Operations

Aircraft

Access comprehensive aircraft and fleet information. These endpoints enable partners to retrieve aircraft data, including status, specifications, and operational details.

Business Value

  • Retrieve complete fleet information, including active and inactive aircraft.
  • Support fleet management and operational planning with detailed aircraft data.
  • Access aircraft specifications, including capacity, category, and home‑base information.

Use Cases

  • Retrieve fleet data for operational planning and scheduling.
  • Integrate aircraft information into external systems for maintenance and logistics.
  • Monitor aircraft status and availability across the fleet.
  • Build fleet‑management dashboards with paginated results.
Operations

Flight Permits

Retrieve flight permit information for takeoff, landing, and overflight permissions. These endpoints enable operators to access flight permit data within the context of the operator data.

Business Value

  • Retrieve accurate flight permit records for compliance and regulatory requirements.
  • Access permit information for operational planning and verification.
  • Monitor permit statuses and details for flights.

Use Cases

  • Retrieve permit information for flights to verify compliance status.
  • Review permit details including status, dates, and associated documents.
  • Access permit information for operational planning and audits.

Operations

Flight Slots & PPRs

Retrieve flight slot and PPR (Prior Permission Required) information. These endpoints enable operators to access flight slot and PPR data within the context of the operator data.

Business Value

  • Retrieve accurate flight slot and PPR records for compliance and operational requirements.
  • Access slot and PPR information for operational planning and verification.
  • Monitor slot and PPR statuses and details for flights.

Use Cases

  • Retrieve slot and PPR information for flights to verify compliance status.
  • Review slot and PPR details including status, approval dates, and associated documents.
  • Access slot and PPR information for operational planning and audits.

Operations

Flight Permits (Provider)

Manage flight permits for takeoff, landing, and overflight permissions. These endpoints enable Trip Support Providers to create, update, retrieve, and delete flight permits, as well as manage associated documents.

Business Value

  • Maintain accurate flight permit records for compliance and regulatory requirements.
  • Streamline permit management processes with automated workflows.
  • Support document management for permit certificates and approvals.
  • Ensure flights have the necessary permissions before operations.

Use Cases

  • Create new flight permits for upcoming flights with permit details and expiration dates.
  • Update existing permit information, including permit numbers, status, and dates.
  • Retrieve permit information for flights to verify compliance status.
  • Upload and manage permit documents, such as certificates and approvals.
  • Delete obsolete permits that are no longer valid or relevant.

Note:

All flight‑permit operations are bound to the operator context associated with the authentication token. Trip Support Providers can manage permits only for flights within their own organization.

Operations

Flight Slots & PPRs (Provider)

Manage flight slots and PPRs (Prior Permission Required). These endpoints enable Trip Support Providers to update, retrieve, and manage flight slots and PPRs, as well as manage associated documents.

Business Value

  • Maintain accurate flight slot and PPR records for compliance and operational requirements.
  • Streamline slot and PPR management processes with automated workflows.
  • Support document management for slot and PPR certificates and approvals.
  • Ensure flights have the necessary slots and PPRs before operations.

Use Cases

  • Update existing slot and PPR information, including permit numbers, status, and approval dates.
  • Retrieve slot and PPR information for flights to verify compliance status.
  • Upload and manage slot and PPR documents, such as certificates and approvals.
  • Delete obsolete slot and PPR documents that are no longer valid or relevant.

Note:

All flight slot and PPR operations are bound to the operator context associated with the authentication token. Trip Support Providers can manage slots and PPRs only for flights within their own organization.

Operations