Skip to content

Webhook (1.0.0)

Webhook API

Languages
Servers
Sandbox Server
https://apitest.drayeasy.com/
Production Server
https://api.drayeasy.com/

Webhook Management

Manage webhooks such as create, list, and remove

Operations

Webhook Events

List of events that can be subscribed to in a webhook

Operations

LTL Shipments Created

Request

The ltl.shipment.created event is posted to an organization's webhooks whenever an LTL Shipment is created.

Bodyapplication/jsonrequired
dataArray of objects(LTLShipmentCreatedDetail)
curl -i -X POST \
  https://apitest.drayeasy.com/ltl/shipment/created/webhook/ \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "event_type": "ltl.shipment.created",
        "serial_number": "SN123456",
        "order_number": "LS241205028749",
        "pickup_company_name": "Pickup Company",
        "pickup_contact_name": "John Doe",
        "pickup_contact_phone": "123-456-7890",
        "pickup_contact_email": "pickup@example.com",
        "pickup_zipcode": "90047",
        "pickup_city": {
          "id": 1,
          "name": "New York",
          "alias": "NY",
          "state": "New York",
          "country": "US",
          "latitude": 40.712776,
          "longitude": -74.005974,
          "full_name": "New York, NY, US"
        },
        "pickup_address1": "123 Main St",
        "pickup_address2": "Apt 4B",
        "destination_company_name": "Destination Company",
        "destination_contact_name": "Jane Doe",
        "destination_contact_phone": "987-654-3210",
        "destination_contact_email": "destination@example.com",
        "destination_zipcode": "92404",
        "destination_city": {
          "id": 1,
          "name": "New York",
          "alias": "NY",
          "state": "New York",
          "country": "US",
          "latitude": 40.712776,
          "longitude": -74.005974,
          "full_name": "New York, NY, US"
        },
        "destination_address1": "456 Elm St",
        "destination_address2": "Suite 5",
        "pro_number": "PRO123456789",
        "pickup_accessorials": [
          "string"
        ],
        "destination_accessorials": [
          "string"
        ],
        "pickup_special_request": "Special request",
        "destination_special_request": "Special request",
        "pickup_number": "123",
        "dropoff_number": "123",
        "customer_reference_number": "REF123",
        "customer_status": "Pending",
        "rate": 2482.04,
        "cargo_value": 1221,
        "premium": 1221,
        "is_insurance_entrusted": true,
        "pickup_open_time": "08:00",
        "pickup_close_time": "18:00",
        "estimated_pickup_date": "2024-12-31",
        "actual_pickup_date": "2024-12-31",
        "estimated_delivery_date": "2025-01-31",
        "actual_delivery_date": "2025-01-31",
        "destination_open_time": "09:00",
        "destination_close_time": "18:00",
        "items": [
          {
            "weight_unit": "lbs",
            "dimension_unit": "in",
            "height": 72,
            "length": 48,
            "width": 40,
            "total_weight": 1200,
            "units": 1,
            "pieces": 1,
            "package_type": "Pallet",
            "description": "general goods"
          }
        ],
        "documents": [
          {
            "file_name": "document.pdf",
            "document_type": "BOL",
            "document_url": "https://example.com/document.pdf"
          }
        ],
        "created_at": "2024-12-05 02:44"
      }
    ]
  }'

Responses

Received webhook events successfully

LTL Shipments Status Updated

Request

The ltl.shipment.status.updated event is posted to an organization's webhooks whenever an LTL Shipment status is updated.

Bodyapplication/jsonrequired
dataArray of objects(ShipmentStatusUpdate)
curl -i -X POST \
  https://apitest.drayeasy.com/ltl/shipment/status/updated/webhook/ \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "event_type": "ltl.shipment.status.updated",
        "order_number": "123456",
        "serial_number": "SN123456",
        "previous_shipment_status": "Pending",
        "new_shipment_status": "Shipped"
      }
    ]
  }'

Responses

Received webhook events successfully

LTL Bill Of Lading Created

Request

The ltl.billOfLading.created event is posted to an organization's webhooks whenever an LTL Bill of Lading is created.

Bodyapplication/jsonrequired
dataArray of objects(DocumentCreated)
curl -i -X POST \
  https://apitest.drayeasy.com/ltl/billOfLading/created/webhook/ \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "event_type": "ltl.billOfLading.created",
        "order_number": "123456",
        "serial_number": "SN123456",
        "documents": {
          "file_name": "bol_123.pdf",
          "document_type": "BOL",
          "document_url": "https://example.com/documents/bol_123.pdf",
          "created_at": "2024-12-01 10:00:00",
          "updated_at": "2024-12-01 15:00:00"
        }
      }
    ]
  }'

Responses

Received webhook events successfully

LTL Proof Of Delivery Created

Request

The ltl.proofOfDelivery.created event is posted to an organization's webhooks whenever an LTL Proof of Delivery is created.

Bodyapplication/jsonrequired
dataArray of objects(DocumentCreated)
curl -i -X POST \
  https://apitest.drayeasy.com/ltl/proofOfDelivery/created/webhook/ \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "event_type": "ltl.billOfLading.created",
        "order_number": "123456",
        "serial_number": "SN123456",
        "documents": {
          "file_name": "bol_123.pdf",
          "document_type": "BOL",
          "document_url": "https://example.com/documents/bol_123.pdf",
          "created_at": "2024-12-01 10:00:00",
          "updated_at": "2024-12-01 15:00:00"
        }
      }
    ]
  }'

Responses

Received webhook events successfully

Certificate Of Insurance Created

Request

The certificateOfInsurance.created event is posted to an organization's webhooks whenever a Certificate of Insurance is created.

Bodyapplication/jsonrequired
dataArray of objects(DocumentCreated)
curl -i -X POST \
  https://apitest.drayeasy.com/certificateOfInsurance/created/webhook/ \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "event_type": "ltl.billOfLading.created",
        "order_number": "123456",
        "serial_number": "SN123456",
        "documents": {
          "file_name": "bol_123.pdf",
          "document_type": "BOL",
          "document_url": "https://example.com/documents/bol_123.pdf",
          "created_at": "2024-12-01 10:00:00",
          "updated_at": "2024-12-01 15:00:00"
        }
      }
    ]
  }'

Responses

Received webhook events successfully

LTL Certificate Of Insurance Created

Request

The ltl.certificateOfInsurance.created event is posted to an organization's webhooks whenever an LTL Certificate of Insurance is created.

Bodyapplication/jsonrequired
dataArray of objects(DocumentCreated)
curl -i -X POST \
  https://apitest.drayeasy.com/ltl/certificateOfInsurance/created/webhook/ \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "event_type": "ltl.billOfLading.created",
        "order_number": "123456",
        "serial_number": "SN123456",
        "documents": {
          "file_name": "bol_123.pdf",
          "document_type": "BOL",
          "document_url": "https://example.com/documents/bol_123.pdf",
          "created_at": "2024-12-01 10:00:00",
          "updated_at": "2024-12-01 15:00:00"
        }
      }
    ]
  }'

Responses

Received webhook events successfully

LTL Label Created

Request

The ltl.label.created event is posted to an organization's webhooks whenever an LTL Label is created.

Bodyapplication/jsonrequired
dataArray of objects(DocumentCreated)
curl -i -X POST \
  https://apitest.drayeasy.com/ltl/label/created/webhook/ \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "event_type": "ltl.billOfLading.created",
        "order_number": "123456",
        "serial_number": "SN123456",
        "documents": {
          "file_name": "bol_123.pdf",
          "document_type": "BOL",
          "document_url": "https://example.com/documents/bol_123.pdf",
          "created_at": "2024-12-01 10:00:00",
          "updated_at": "2024-12-01 15:00:00"
        }
      }
    ]
  }'

Responses

Received webhook events successfully

Copyleft © DrayEasy Inc. No rights reserved.