Skip to content
/
Get webhook deliveries

FL3XX API (2.0.0)

FL3XX API v2.0 - Beta Release

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

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 and 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:

The data managed by the Airport Fuel Prices endpoints is strictly bound to the context of the operator associated with the calling 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:

  • 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(s) changes
  • 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 (e.g. new passengers, updated list, passenger document changes, etc.)
Operations

Renew a webhook subscription

Request

Renew an existing webhook subscription to extend its expiration date.

Features:

  • Extends subscription expiration by 1 month from current expiration date.
  • Subscriptions can only be renewed 5 days before expiration.

Example Use Case: An operations manager wants to continue receiving webhook notifications for an existing subscription. Using this endpoint, they can extend the subscription without recreating it.

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

The unique identifier of the webhook subscription to renew.

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

Responses

Successfully renewed 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"
}

Get webhook deliveries

Request

Retrieve paginated webhook delivery history for the authenticated partner and operator.

Note: Only failed deliveries are supported at this time.

Features:

  • Returns paginated delivery history with filtering and sorting
  • Supports filtering by issue date and status
  • Default sorting by issue date (descending)

    Example Use Case: An operations manager needs to monitor webhook delivery to troubleshoot failed deliveries. Using this endpoint, they can review delivery history and identify patterns in webhook failures.
Security
X-Api-Client-Id and X-Auth-Token
Query
filterstringrequired

Filter by issueDate and status.

Required filters:

  • issueDate with GTE operator (greater than or equal)
    • Date Constraints: Can be up to 2 months in the past.
    • Date format: YYYY-MM-DDTHH:mm:ss.SSSZ
    • Date value must be url encoded. Example: the following value issueDate,GTE,2025-01-01T10:23:57.980Z&filter=status,EQ,FAILED would be encoded and sent as issueDate%2CGTE%2C2025-01-01T10%3A23%3A57.980Z&filter=status%2CEQ%2CFAILED.
  • status with EQ operator (equal)
    • Supported values: FAILED
Example: filter=issueDate%2CGTE%2C2025-01-01T10%3A23%3A57.980Z&filter=status%2CEQ%2CFAILED
limitinteger[ 10 .. 50 ]

Maximum number of records to return.

Default 10
Example: limit=20
offsetinteger>= 0

Number of records to skip before starting to return results.

Default 0
Example: offset=6
sortstring

Sort criteria in the format: field direction

Supported sort fields:

  • issueDate (default: desc)
Default "issueDate desc"
Example: sort=issueDate,desc
curl -i -X GET \
  'https://test.fl3xx.com/api/v2/webhooks/deliveries?filter=issueDate%252CGTE%252C2025-01-01T10%253A23%253A57.980Z%26filter%3Dstatus%252CEQ%252CFAILED&limit=20&offset=6&sort=issueDate%2Cdesc' \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Successfully retrieved webhook deliveries

Bodyapplication/json
dataArray of objects(WebhookDeliveryDto)

The list of webhook deliveries for the current page.

paginationobject(Pagination)

Pagination details

Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 20,
    "totalItems": 150,
    "sortItems": [ … ],
    "filters": [ … ]
  }
}