# Get webhook deliveries

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.

Endpoint: GET /api/v2/webhooks/deliveries
Version: 2.4.0
Security: X-Api-Client-Id, X-Auth-Token

## Query parameters:

  - `filter` (string, required)
    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: "issueDate%2CGTE%2C2025-01-01T10%3A23%3A57.980Z&filter=status%2CEQ%2CFAILED"

  - `limit` (integer)
    Maximum number of records to return.
    Example: 20

  - `offset` (integer)
    Number of records to skip before starting to return results.
    Example: 6

  - `sort` (string)
    Sort criteria in the format: field direction

Supported sort fields:
- issueDate (default: desc)
    Example: "issueDate,desc"

## Response 200 fields (application/json):

  - `data` (array)
    The list of webhook deliveries for the current page.

  - `data.id` (string)
    Unique identifier for the webhook delivery attempt.
    Example: "delivery-12345"

  - `data.resourceType` (string)
    The type of resource that triggered the webhook delivery.
    Enum: "FLIGHT"

  - `data.resourceId` (string)
    The unique identifier of the resource that triggered the webhook delivery.
    Example: "flight-67890"

  - `data.event` (string)
    The event type that triggered this webhook delivery.

Subscribable Event Types:
- Individual event types that can be subscribed to: FLIGHT_CREATE, FLIGHT_CANCEL, FLIGHT_TIME_UPDATE, FLIGHT_AIRCRAFT_UPDATE, FLIGHT_AIRPORT_UPDATE, FLIGHT_POST_FLIGHT_STATUS, FLIGHT_MOVEMENT_UPDATE, FLIGHT_PAX_COUNT_UPDATE, FLIGHT_PAX_LIST_UPDATE, FLIGHT_PERMIT_ASSIGNMENT, FLIGHT_PERMIT_UNASSIGNMENT

Group Event Types (not subscribable; appear 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.
    Enum: "FLIGHT_CREATE", "FLIGHT_CANCEL", "FLIGHT_TIME_UPDATE", "FLIGHT_AIRCRAFT_UPDATE", "FLIGHT_AIRPORT_UPDATE", "FLIGHT_POST_FLIGHT_STATUS", "FLIGHT_MOVEMENT_UPDATE", "FLIGHT_PAX_COUNT_UPDATE", "FLIGHT_PAX_LIST_UPDATE", "FLIGHT_PERMIT_UPDATE", "FLIGHT_PERMIT_ASSIGNMENT", "FLIGHT_PERMIT_UNASSIGNMENT", "FLIGHT_UPDATE", "FLIGHT_PASSENGER_UPDATE", "FLIGHT_PERMIT_UPDATE", "FLIGHT_SLOT_PPR_UPDATE", "FLIGHT_SLOT_PPR_ASSIGNMENT", "FLIGHT_SLOT_PPR_UNASSIGNMENT", "FLIGHT_FBO_UPDATE", "FLIGHT_FBO_ASSIGNMENT", "FLIGHT_FBO_UNASSIGNMENT", "FLIGHT_HOTEL_UPDATE", "FLIGHT_HOTEL_ASSIGNMENT", "FLIGHT_HOTEL_UNASSIGNMENT", "FLIGHT_CATERING_UPDATE", "FLIGHT_CATERING_ASSIGNMENT", "FLIGHT_CATERING_UNASSIGNMENT", "FLIGHT_TRANSPORT_UPDATE", "FLIGHT_TRANSPORT_ASSIGNMENT", "FLIGHT_TRANSPORT_UNASSIGNMENT", "FLIGHT_CREW_LIST_UPDATE", "FLIGHT_CREW_ASSIGNMENT", "FLIGHT_CREW_DOCUMENT_UPDATE", "FLIGHT_CREW_ADDRESS_UPDATE"

  - `data.status` (string)
    The delivery status indicating whether the webhook was successfully delivered.
    Enum: "FAILED"

  - `data.completedAtDateTime` (string)
    The date and time (UTC) when the webhook delivery attempt was completed.
    Example: "2024-01-15T10:30:00.000Z"

  - `pagination` (object)
    Pagination details

  - `pagination.offset` (integer)
    Number of records skipped

  - `pagination.limit` (integer)
    Maximum number of records returned
    Example: 20

  - `pagination.totalItems` (integer)
    Total number of items available
    Example: 150

  - `pagination.sortItems` (array)
    List of fields used for sorting
    Example: ["issueDate desc"]

  - `pagination.filters` (array)
    List of applied filters

  - `pagination.filters.field` (string)
    Field name to filter by
    Example: "issueDate"

  - `pagination.filters.operator` (string)
    Filter operator
    Example: "gte"

  - `pagination.filters.value` (string)
    Filter value
    Example: "2024-01-01T00:00:00.000Z"


## Response 400 fields

## Response 401 fields

## Response 403 fields