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

# On Carrier Created

> Sent by Vooma to your server when a carrier is created.

<Warning>
  <strong>Beta Feature:</strong> This functionality is currently in beta. You
  may experience changes or limited support as we continue to improve it.
</Warning>


## OpenAPI

````yaml WEBHOOK onCarrierCreated
openapi: 3.1.0
info:
  title: api
  version: 0.1.0
  contact: {}
servers:
  - url: https://api.vooma.ai/v0
    description: Vooma API
security: []
paths:
  onCarrierCreated:
    post:
      description: Sent by Vooma to your server when a carrier is created.
      operationId: OnCarrierCreated
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierCreatedEvent'
      responses:
        '200':
          description: OK
        '204':
          description: No content
      security: []
components:
  schemas:
    CarrierCreatedEvent:
      $ref: '#/components/schemas/V0Carrier.CarrierCreatedEvent'
    V0Carrier.CarrierCreatedEvent:
      properties:
        carrier:
          $ref: '#/components/schemas/Carrier'
        event:
          type: string
          enum:
            - carrier.created
          nullable: false
      required:
        - carrier
        - event
      type: object
    Carrier:
      $ref: '#/components/schemas/MayHaveID_CarrierData_'
    MayHaveID_CarrierData_:
      allOf:
        - properties:
            id:
              type: string
          type: object
        - $ref: '#/components/schemas/CarrierData'
    CarrierData:
      properties:
        equipment:
          items:
            $ref: '#/components/schemas/CarrierEquipment'
          type: array
        contacts:
          items:
            $ref: '#/components/schemas/CarrierContact'
          type: array
        dotNumber:
          type: string
        mcNumber:
          type: string
        name:
          type: string
      required:
        - name
      type: object
    CarrierEquipment:
      properties:
        trailerNumber:
          type: string
        truckNumber:
          type: string
        equipment:
          $ref: '#/components/schemas/Equipment'
      required:
        - equipment
      type: object
    CarrierContact:
      properties:
        contact:
          $ref: '#/components/schemas/Contact'
        type:
          type: string
          enum:
            - DRIVER
            - DISPATCH
      required:
        - contact
        - type
      type: object
    Equipment:
      $ref: '#/components/schemas/V0Equipment.Equipment'
    Contact:
      $ref: '#/components/schemas/V0Contact.Contact'
    V0Equipment.Equipment:
      properties:
        type:
          anyOf:
            - $ref: '#/components/schemas/EquipmentType'
            - type: string
          description: Typically one of the EquipmentType enum values but subject to change
        equipmentLength:
          $ref: '#/components/schemas/Dimension'
        temperature:
          $ref: '#/components/schemas/Temperature'
        description:
          type: string
      required:
        - type
      type: object
      additionalProperties: false
    V0Contact.Contact:
      $ref: '#/components/schemas/MayHaveID_ContactData_'
    EquipmentType:
      enum:
        - BOX_TRUCK
        - CARGO_VAN
        - CONESTOGA
        - CONTAINER
        - DOUBLE_DROP
        - DRY_VAN
        - FLATBED
        - HOT_SHOT
        - LOW_BOY
        - POWER_ONLY
        - REEFER
        - REMOVABLE_GOOSENECK
        - SPRINTER_VAN
        - STEP_DECK
        - STRAIGHT_TRUCK
        - AUTO_CARRIER
        - VAN_OR_REEFER
        - FLATBED_OR_STEP_DECK
        - OTHER
      type: string
    Dimension:
      $ref: '#/components/schemas/V0Dimensions.Dimension'
    Temperature:
      properties:
        units:
          $ref: '#/components/schemas/TemperatureUnits'
        max:
          type: number
          format: double
        min:
          type: number
          format: double
      required:
        - units
      type: object
    MayHaveID_ContactData_:
      allOf:
        - properties:
            id:
              type: string
          type: object
        - $ref: '#/components/schemas/ContactData'
    V0Dimensions.Dimension:
      properties:
        value:
          type: number
          format: double
        units:
          anyOf:
            - $ref: '#/components/schemas/DimensionUnits'
            - type: string
          description: >-
            Typically one of the DimensionUnits enum values but subject to
            change
      required:
        - value
        - units
      type: object
      additionalProperties: false
    TemperatureUnits:
      enum:
        - F
        - C
      type: string
    ContactData:
      anyOf:
        - $ref: '#/components/schemas/CarrierContactData'
        - $ref: '#/components/schemas/CustomerContactData'
        - $ref: '#/components/schemas/LocationContactData'
    DimensionUnits:
      enum:
        - IN
        - CM
        - FT
      type: string
    CarrierContactData:
      allOf:
        - $ref: '#/components/schemas/BaseContactData'
        - properties:
            carrierId:
              type: string
          required:
            - carrierId
          type: object
    CustomerContactData:
      allOf:
        - $ref: '#/components/schemas/BaseContactData'
        - properties:
            customerId:
              type: string
          required:
            - customerId
          type: object
    LocationContactData:
      $ref: '#/components/schemas/BaseContactData'
    BaseContactData:
      properties:
        name:
          type: string
        phone:
          type: string
        email:
          type: string
        role:
          type: string
      type: object

````