---
title: Equipment Update
slug: fourkites-api-reference/equipment-update
createdAt: 2024-01-18T11:01:20.000Z
---

The following message is sent to a subscribed URL when a trailer is updated while on site. This is associated with the Equipment\_Update trigger. A list of actions which trigger an equipment update webhook are below:

- Location change (either yard spot change or door change)
- Move request status change
- Trailer name updated
- Trailer load status change
- Trailer process status change
- Trailer type change
- Trailer carrier change
- Trailer condition change

## Field Definitions

All fields on the webhooks will be present on every message, the schema is static. However, the **Required** field on each will notate whether or not a field can be nullable. For array values, an empty array would return if optional and an empty list.

- Optional **String** field example when `empty: "updated_by": null`
- Optional **Array** field example when `empty: "load_numbers": []`

### Custom Trailer Attributes

The additional\_attributes array contains a list of custom attributes created on the trailer check-in form and are configured in the **Nomenclature** setup. If your organization does not have a need for custom fields to be entered by users in Dynamic Yard, this array will be empty. Otherwise, the fields and their values will be listed.

### Trailer / Equipment Detail

- `additional_attributes`
  - **Type**: Array
  - **Required**: O
  - **Description**: Array of additional/custom attributes created on the trailer. If no custom attributes are defined in the company setup, this will be an empty array. \*See the Custom Attributes section in the description for more information
- `audit_trailer`
  - **Type**: Boolean
  - **Required**: O
  - **Description: **Indicates whether the trailer needs to be audited. If not used, the field will pass as `null`
- `audit_trailer_notes`
  - **Type**: String
  - **Required**: O
  - **Description: **Notes left about the trailer's audit status. If no notes are left, the field will pass as `null`
- `comments`
  - **Type**: String
  - **Required**: O
  - **Description: **Comments left on the trailer. If no comments are left, the field will pass as `null`
- `equipment_type`
  - **Type**: String
  - **Required**: M
  - **Description**: The type of trailer (e.g. 53' Dry Van, Container, etc.). Values are configurable in the UI as customer master data
- `location_name`
  - **Type**: String
  - **Required**: O
  - **Description**: Name of current location of the trailer. Will be either a parking spot name or dock door name
- `location_parent_name`
  - **Type**: String
  - **Required**: O
  - **Description: **Name of the dock or parking lot where the trailer is currently located. If the trailer is in a parking spot, this will be the parking lot name associated with that spot. If the trailer is in a dock door, this will be the dock name associated with that door. If the trailer has an "Unassigned" location then this will be `null`
- `location_type`
  - **Type**: String
  - **Required**: M
  - **Description**: Type of the current location of the trailer. Will be either "Spot" or "Door"
- `message_type`
  - **Type**: String
  - **Required**: M
  - **Description**: Type of webhook. Will always be EQUIPMENT\_CALLBACK
- `out_of_service`
  - **Type**: Boolean
  - **Required**: M
  - **Description**: true/false indicator as to whether the trailer is eligible for use
- `out_of_service_notes`
  - **Type**: String
  - **Required**: O
  - **Description: **Notes left about the trailer's service status. If no notes left, field will pass as `null`
- `seal_number`
  - **Type**: String
  - **Required**: O
  - **Description**: Seal number associated with the trailer
- `seal_status`
  - **Type**: String
  - **Required**: O
  - **Description**: Seal status of the trailer (e.g. "Intact" or "Broken")
- `site_code`
  - **Type**: String
  - **Required**: M
  - **Description**: Unique identifier for the site
- `trailer_condition`
  - **Type**: String
  - **Required**: O
  - **Description**: Condition of the trailer (e.g. "Clean", "Dirty"). Values are configurable as master data
- `trailer_damage`
  - **Type**: Boolean
  - **Required**: O
  - **Description: **Boolean flag indicating whether or not the trailer is damaged. If not checked, field will pass as `null`
- `trailer_damage_notes`
  - **Type**: String
  - **Required**: O
  - **Description: **Notes left about the damage status of a trailer. If no notes are used, field will pass as `null`
- `trailer_id`
  - **Type**: String
  - **Required**: M
  - **Description**: Unique trailer ID generated by Dynamic Yard. It is recommended to store this ID as it is used for other Dynamic Yard APIs
- `trailer_number`
  - **Type**: String
  - **Required**: M
  - **Description**: Trailer number entered by the gate upon check-in
- `timestamp`
  - **Type**: ISO8601 Date/Time
  - **Required**: M
  - **Description**: Timestamp of when the trailer was updated/edited. Will be in UTC
- `updated_by`
  - **Type**: String
  - **Required**: M
  - **Description: **Username of the user who edited the trailer in Dynamic Yard. Will be `null` for updates done via the Trailer Update API

### Delivery / Shipment Detail

- `delivery_ids`
  - **Type**: Array
  - **Required**: O
  - **Description**: List of delivery IDs (shipments) associated with the trailer. These are listed on the delivery object. Will only be populated if the trailer is full
- `load_numbers`
  - **Type**: String
  - **Required**: O
  - **Description**: List of load numbers associated with the trailer. These correspond to the "Bill of Lading" value on the delivery object. Will only be populated if the trailer is full
- `load_status`
  - **Type**: String
  - **Required**: M
  - **Description**: Load status associated with the trailer. This is often updated when the warehouse is finished loading/unloading the trailer.
- `process_status`
  - **Type**: String
  - **Required**: O
  - **Description: **Process status of the trailer. See WMS API section for more information on `process_status`

### Carrier / Transaction Detail

- `carrier_name`
  - **Type**: String
  - **Required**: M
  - **Description**: Name of the carrier which owns the trailer
- `gate_pass_number`
  - **Type**: Int(32)
  - **Required**: M
  - **Description**: Gate pass ID which is automatically generated when a trailer is checked into the yard
- `scac`
  - **Type**: String
  - **Required**: M
  - **Description**: SCAC or carrier code of the company which owns the trailer

### Additional Attributes Detail

The following fields will only be present if custom attributes are configured on the trailer check-in form. Specifically, the array lists an object with the following fields. If custom attributes are not used by your company, then the `additional_attributes` array will be empty.

- `form`
  - **Type**: String
  - **Required**: O
  - **Description: **The data object which the attribute is created for. On the Gate Check-In webhook, this will be `trailer`
- `label`
  - **Type**: String
  - **Required**: O
  - **Description**: Label users see for the field in the UI
- `name`
  - **Type**: String
  - **Required**: O
  - **Description: **Field name stored on the Dynamic Yard back-end. Can be used to match to the field when processing the Gate Check-In webhook programmatically to avoid parsing spaces and special characters that might be used in the UI label (listed above)
- `type`
  - **Type**: String
  - **Required**: O
  - **Description**: Data type of the custom attribute. Available types include: Text | Option | Toggle (yes/no)
- `value`
  - **Type**: String/Boolean\*
  - **Required**: O
  - **Description: **The actual value entered in the field. \*For text type values, the field will be returned as a string. For boolean type values, it will be a boolean data type