# Webhook Request Body

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    Webhook Request Body:
      type: object
      properties:
        event:
          type: string
          description: name
          enum:
            - submit
            - begin
            - end
            - error
          x-apidog-enum:
            - value: submit
              name: ''
              description: The task has been submitted to the processing pipeline
            - value: begin
              name: ''
              description: The task has started.
            - value: end
              name: ''
              description: The task has ended successfully or with an error.
            - value: error
              name: ''
              description: The task has failed. See `exception` for details
        appName:
          type: string
          description: The unique and immutable identifier of the app.
        orgName:
          type: string
          description: >-
            The unique and immutable organization identifier which the app
            belongs to.
        type:
          type: string
          enum:
            - dltar
            - mkraw
            - deploy
          x-apidog-enum:
            - value: dltar
              name: ''
              description: The event was sent from the import-build task
            - value: mkraw
              name: ''
              description: The event was send from the ROCKIT image builder task
            - value: deploy
              name: ''
              description: The event was sent from the publish task
        exception:
          type: object
          properties:
            httpDownloadFailed:
              type: object
              properties:
                url:
                  type: string
                  description: The provided URL from which the task attempted the download
                sizeBytes:
                  type: number
                  description: The size of the downloaded file in bytes.
                  minimum: 0
                httpStatus:
                  type: number
                  description: Http status code
                  minimum: 100
                  maximum: 600
                exitCode:
                  type: number
                  description: Exit code of the downloader
                  minimum: 0
                  maximum: 127
              x-apidog-orders:
                - url
                - httpStatus
                - exitCode
                - sizeBytes
              description: >-
                Download from the provided URL failed. Can be triggered by
                `dltar`.
              required:
                - url
            fileReadFailed:
              type: object
              properties:
                filename:
                  type: string
                  description: Name of the downloaded file.
                typeExpected:
                  type: string
                  description: File type which was expected, e.g., `tar`
                typeDetected:
                  type: string
                  description: The detected file type
              x-apidog-orders:
                - filename
                - typeExpected
                - typeDetected
              description: >-
                The downloaded file has wrong type or is corrupted. Can be
                triggered by `mkraw`.
              required:
                - filename
                - typeExpected
          x-apidog-orders:
            - httpDownloadFailed
            - fileReadFailed
          description: A non-blocking exception has occurred.
        error:
          type: object
          properties:
            deployment:
              type: object
              properties:
                failedDeployments:
                  type: array
                  items:
                    type: string
                    description: Deployment Name
                  description: Names of the deployments that were unsuccessful
                succeededDeployments:
                  type: array
                  items:
                    type: string
                    description: Deployment Name
                  description: Names of the deployments that were successful
              x-apidog-orders:
                - failedDeployments
                - succeededDeployments
              description: identifier of the deployment to which data could not be copied.
              required:
                - failedDeployments
                - succeededDeployments
          x-apidog-orders:
            - deployment
          description: >-
            A blocking error occurred. Requires user action to be resolved. Can
            be triggered by `deploy`.
        buildName:
          type: string
          description: >-
            Only on type 'deploy' for all events: the build number of which dxf
            images or patches are deployed.
        dxfName:
          type: string
          description: >-
            Only on type 'deploy' for all events: the dxf image identifier of
            the (currently) deployed image.
        buildChanged:
          type: boolean
          description: >-
            Only on type 'deploy' and event 'end': signals whether the current
            active buildName has changed on this deployment.
      x-apidog-orders:
        - type
        - event
        - orgName
        - appName
        - buildName
        - dxfName
        - buildChanged
        - exception
        - error
      required:
        - event
        - appName
        - orgName
        - type
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://Example-Server.com
    description: Default
security: []

```