General information about Callback URL

This solution allows you to download event statuses from the Trans.eu Platform. To the return address provided by the customer (callback_url), event statuses are sent for objects (freights, orders, etc.) with a return address. To receive notifications about events related to the added objects (freights, orders, etc.):

callback address should start with protocol (http:// or https://)

Callback flow

Callback Flow

Example of using “callback_url” when creating a new freight:

{
  "external_source": "1_api",
  "callback_url": "http://example.com/msg",
  "publish": true,
  "capacity": 15,
  "requirements": {
    "is_ftl": true,
    "required_truck_bodies": [
      "cooler"
    ]
  },
  "loads": [

  ],
  "spots": [
    {
      "spot_order": 1,
      "operations": [
        {
          "type": "loading",
          "timespans": {
            "begin": "2021-02-02T15:00:00+0000",
            "end": "2021-02-02T16:00:00+0000"
          },
          "operation_order": 1
        }
      ],
      "place": {
        "address": {
          "country": "PL",
          "postal_code": "96-500",
          "locality": "Sochaczew"
        }
      }
    },
    {
      "spot_order": 2,
      "operations": [
        {
          "type": "unloading",
          "timespans": {
            "begin": "2021-02-03T21:59:59+0000",
            "end": "2021-02-03T21:59:59+0000"
          },
          "operation_order": 1
        }
      ],
      "place": {
        "address": {
          "country": "PL",
          "postal_code": "50-261",
          "locality": "Wrocław"
        }
      }
    }
  ]
}

List of freight payloads received to callback URL

Metod Status (event_name) JSON example
POST freights.publication.rejected_by_all_carriers
{
"id": "12345",
"event_name": "{freights.publication.rejected_by_all_carriers}",
"data": {}
}
POST freights.freight.order_from_contract_was_created
{
"id": "12345",
"event_name": "{freights.freight.order_from_contract_was_created}",
"data": {}
}
POST freights_processing.publication.finished
{
"id": "12345",
"event_name": "{freights_processing.publication.finished}",
"data": {}
}
POST freights.freight.create
{
"id": "12345",
"event_name": "{freights.freight.create}",
"data": {}
}
POST freights.publication.accepted
{
"id": "12345",
"event_name": "{freights.publication.accepted}",
"data": {}
}
POST freights.publication.created
{
"id": "12345",
"event_name": "{freights.publication.created}",
"data": {}
}
POST freights.proposal_request.rejected
{
"id": "12345",
"event_name": "{freights.proposal_request.rejected}",
"data": {}
}
POST freights.recommended_carriers.found
{
"id": "12345",
"event_name": "{freights.recommended_carriers.found}",
"data": {}
}
POST freights.freight.update
{
"id": "12345",
"event_name": "{freights.freight.update}",
"data": {}
}
POST freights.publication.finished
{
"id": "12345",
"event_name": "{freights.publication.finished}",
"data": {}
}
POST freights.proposal_request.negotiated
{
"id": "12345",
"event_name": "{freights.proposal_request.negotiated}",
"data": {
"price": 1000
}
}
POST freights.proposal_request.accepted
{
"id": "12345",
"event_name": "{freights.proposal_request.accepted}",
"data": {
"price": 1000
}
POST freights.publication.carrier_assign
{
"id": "12345",
"event_name": "{freights.publication.carrier_assign}",
"data": {}
}
POST freights_processing.publication.negotiation_time_finished
{
"id": "12345",
"event_name": "{freights_processing.publication.negotiation_time_finished}",
"data": {}
}
POST freights.publication.canceled
{
"id": "12345",
"event_name": "{freights.publication.canceled}",
"data": {}
}
POST freights_processing.proposal_request.offer_timeout
{
"id": "12345",
"event_name": "{freights_processing.proposal_request.offer_timeout}",
"data": {}
}

List of orders payloads received to callback URL

Metod Status (event_name) JSON example
POST freight_orders.order.vehicle_and_driver_have_changed
{
"id": "12345",
"event_name": "{freight_orders.order.vehicle_and_driver_have_changed}",
"data": {}
}
POST freight_orders.order.attachment_removed
{
"id": "12345",
"event_name": "{freight_orders.order.attachment_removed}",
"data": {}
}
POST freight_orders.order.attachment_added
{
"id": "12345",
"event_name": "{freight_orders.order.attachment_added}",
"data": {}
}
POST freight_orders.order.attachment_visibility_changed
{
"id": "12345",
"event_name": "{freight_orders.order.attachment_visibility_changed}",
"data": {}
}
POST freight_orders.order.shipment_external_id_was_changed
{
"id": "12345",
"event_name": "{freight_orders.order.shipment_external_id_was_changed}",
"data": {}
}
POST freight_orders.order.order_was_accepted_by_contract
{
"id": "12345",
"event_name": "{freight_orders.order.order_was_accepted_by_contract}",
"data": {}
}
POST freight_orders.order.created
{
"id": "12345",
"event_name": "{freight_orders.order.created}",
"data": {}
}
POST freight_orders.order.proposal_submitted
{
"id": "12345",
"event_name": "{freight_orders.order.proposal_submitted}",
"data": {}
}
POST freight_orders.order.proposal_was_accepted
{
"id": "12345",
"event_name": "{freight_orders.order.proposal_was_accepted}",
"data": {}
}
POST freight_orders.order.order_was_cancelled
{
"id": "12345",
"event_name": "{freight_orders.order.order_was_cancelled}",
"data": {}
}

List of Dock Scheduler payloads received to callback URL

Metod Status (event_name) JSON example
POST time_slot_management.announcement.created
{
"id": "12345",
"event_name": "{time_slot_management.announcement.created}",
"data": {}
}
POST time_slot_management.announcement.deleted
{
"id": "12345",
"event_name": "{time_slot_management.announcement.deleted}",
"data": {}
}
POST time_slot_management.announcement.updated
{
"id": "12345",
"event_name": "{time_slot_management.announcement.updated}",
"data": {}
}
POST time_slot_management.time_window.created
{
"id": "12345",
"event_name": "{time_slot_management.time_window.created}",
"data": {}
}
POST time_slot_management.time_window.deleted
{
"id": "12345",
"event_name": "{time_slot_management.time_window.deleted}",
"data": {}
}
POST time_slot_management.time_window.matching_result_with_freight_order_operations
{
"id": "12345",
"event_name": "{time_slot_management.time_window.matching_result_with_freight_order_operations}",
"data": {}
}
POST time_slot_management.time_window.updated
{
"id": "12345",
"event_name": "{time_slot_management.time_window.updated}",
"data": {}
}

List of monitorings payloads received to callback URL

Metod Status (event_name) JSON example
POST loads_monitoring.monitoring.monitoring_created
{
"id": "12345",
"event_name": "{loads_monitoring.monitoring.monitoring_created}",
"data": {}
}
POST loads_monitoring.monitoring.monitoring_aborted
{
"id": "12345",
"event_name": "{loads_monitoring.monitoring.monitoring_aborted}",
"data": {}
}
POST loads_monitoring.monitoring.monitoring_completed
{
"id": "12345",
"event_name": "{loads_monitoring.monitoring.monitoring_completed}",
"data": {}
}
POST loads_monitoring.monitoring.device_added
{
"id": "12345",
"event_name": "{loads_monitoring.monitoring.device_added}",
"data": {}
}
POST loads_monitoring.monitoring.device_removed
{
"id": "12345",
"event_name": "{loads_monitoring.monitoring.device_removed}",
"data": {}
}
POST loads_monitoring.monitoring.monitoring_state_updated
{
"id": "12345",
"event_name": "{loads_monitoring.monitoring.monitoring_state_updated}",
"data": {}
}