# 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.

<br/>

**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.

<br/>      

**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. 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. Includes: `FLIGHT_PAX_COUNT_UPDATE`, `FLIGHT_PAX_LIST_UPDATE`.
- `FLIGHT_PERMIT_UPDATE`: Group event that combines permit-related events. Includes: `FLIGHT_PERMIT_ASSIGNMENT`, `FLIGHT_PERMIT_UNASSIGNMENT`.
- `FLIGHT_SLOT_PPR_UPDATE`: Group event that combines slot/PPR-related events. Includes: `FLIGHT_SLOT_PPR_ASSIGNMENT`, `FLIGHT_SLOT_PPR_UNASSIGNMENT`.
- `FLIGHT_FBO_UPDATE`: Group event that combines FBO-related events. Includes: `FLIGHT_FBO_ASSIGNMENT`, `FLIGHT_FBO_UNASSIGNMENT`.
- `FLIGHT_TRANSPORT_UPDATE`: Group event that combines transport-related events. Includes: `FLIGHT_TRANSPORT_ASSIGNMENT`, `FLIGHT_TRANSPORT_UNASSIGNMENT`.
- `FLIGHT_HOTEL_UPDATE`: Group event that combines hotel-related events. Includes: `FLIGHT_HOTEL_ASSIGNMENT`, `FLIGHT_HOTEL_UNASSIGNMENT`.
- `FLIGHT_CATERING_UPDATE`: Group event that combines catering-related events. Includes: `FLIGHT_CATERING_ASSIGNMENT`, `FLIGHT_CATERING_UNASSIGNMENT`.
- `FLIGHT_CREW_UPDATE`: Group event that combines flight crew-related events. Includes: `FLIGHT_CREW_LIST_UPDATE`, `FLIGHT_CREW_ASSIGNMENT`, `FLIGHT_CREW_DOCUMENT_UPDATE`, `FLIGHT_CREW_ADDRESS_UPDATE`.

<br/>
            
For more information on setting up and managing webhooks, see the [Event Notifications (Webhook) Guide](/guides/guides/event-notifications).

**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.


## Get webhook subscriptions

 - [GET /api/v2/webhooks/subscriptions](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionsget.md): Retrieves all webhook subscriptions for the authenticated partner and operator.

Features:
- Returns active and inactive webhook subscriptions
- Filtered by partner and operator context

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

## Create a new webhook subscription

 - [POST /api/v2/webhooks/subscriptions](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionpost.md): Creates a new webhook subscription for receiving near‑real‑time event notifications.

Features:
- Validates the callback URL format; only HTTPS is supported
- Sets an automatic expiration date of 30 days for subscriptions

Example Use Case: An operations manager needs to receive near‑real‑time notifications when flight times change. By creating a webhook subscription for FLIGHT_TIME_UPDATE events, they can automatically sync flight data with external systems.

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

## Get webhook subscription by ID

 - [GET /api/v2/webhooks/subscriptions/{subscriptionId}](https://developer.fl3xx.com/reference/v2/webhooks/gebhooksubscriptionbyidget.md): 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.

## Update webhook subscription callback URL or status

 - [PATCH /api/v2/webhooks/subscriptions/{subscriptionId}](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionbyidpatch.md): 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.

## Delete a webhook subscription

 - [DELETE /api/v2/webhooks/subscriptions/{subscriptionId}](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionbyiddelete.md): 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.

## Renew a webhook subscription

 - [POST /api/v2/webhooks/subscriptions/{subscriptionId}/renewals](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionrenewalpost.md): Renews 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.

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

## Get webhook deliveries

 - [GET /api/v2/webhooks/deliveries](https://developer.fl3xx.com/reference/v2/webhooks/webhookdeliveriesget.md): 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.

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