> ## Documentation Index
> Fetch the complete documentation index at: https://docs.videobgremover.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get webhook delivery history

> Retrieve the delivery history for webhooks sent for a specific video job.
Shows all delivery attempts, their status, and any error messages.




## OpenAPI

````yaml https://videobgremover.com/openapi.yaml get /v1/webhooks/deliveries
openapi: 3.0.3
info:
  title: VideoBGRemover API
  version: 1.6.0
  description: >
    Remove backgrounds from videos using AI-powered processing. 


    The VideoBGRemover API allows you to:

    - Upload videos or provide URLs for processing

    - Remove backgrounds with customizable options

    - Generate transparent videos in multiple formats

    - Compose videos on custom backgrounds (server-side)

    - Track processing status and manage credits


    ## Authentication

    All API requests require authentication using an API key in the `X-Api-Key`
    header.


    ## Credits System

    Video processing costs 1 credit per second of video duration.
  contact:
    name: VideoBGRemover API Support
    url: https://videobgremover.com/contact
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.videobgremover.com
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Jobs
    description: Video processing job management
  - name: Credits
    description: Credit balance and usage
  - name: API
    description: API metadata and documentation
  - name: Webhooks
    description: Webhook delivery and history
paths:
  /v1/webhooks/deliveries:
    get:
      tags:
        - Webhooks
      summary: Get webhook delivery history
      description: >
        Retrieve the delivery history for webhooks sent for a specific video
        job.

        Shows all delivery attempts, their status, and any error messages.
      operationId: getWebhookDeliveries
      parameters:
        - name: video_id
          in: query
          required: true
          schema:
            type: string
            format: uuid
          description: Video job ID to get webhook delivery history for
      responses:
        '200':
          description: Webhook delivery history retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDeliveryHistory'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    WebhookDeliveryHistory:
      type: object
      properties:
        video_id:
          type: string
          format: uuid
          description: Video job ID
        total_deliveries:
          type: integer
          description: Total number of delivery attempts
        deliveries:
          type: array
          items:
            $ref: '#/components/schemas/WebhookDelivery'
          description: List of webhook delivery attempts
    WebhookDelivery:
      type: object
      properties:
        event_type:
          type: string
          enum:
            - job.started
            - job.completed
            - job.failed
          description: Type of event that triggered the webhook
        webhook_url:
          type: string
          format: uri
          description: Webhook URL that was called
        attempt_number:
          type: integer
          description: Delivery attempt number (starts at 1)
        delivery_status:
          type: string
          enum:
            - pending
            - delivered
            - failed
          description: Current delivery status
        http_status_code:
          type: integer
          description: HTTP status code from the webhook call
          nullable: true
        error_message:
          type: string
          description: Error message if delivery failed
          nullable: true
        scheduled_at:
          type: string
          format: date-time
          description: When the delivery was scheduled
        delivered_at:
          type: string
          format: date-time
          description: When the delivery was completed (successful or failed)
          nullable: true
        payload:
          type: object
          description: Webhook payload that was sent
        created_at:
          type: string
          format: date-time
          description: When the delivery record was created
    APIError:
      type: object
      properties:
        error:
          type: string
          description: Error message
        details:
          type: string
          description: Additional error details
  responses:
    BadRequest:
      description: Bad request - Invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIError'
          examples:
            invalid_background:
              summary: Invalid background color
              value:
                error: >-
                  Invalid background color format. Must be hex color like
                  #FF0000
            missing_params:
              summary: Missing required parameters
              value:
                error: Must provide either (filename + content_type) OR video_url
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIError'
          example:
            error: Invalid API key
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIError'
          example:
            error: Internal server error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API key with format `vbr_` followed by 32 characters

````