Platform events

The feedback endpoint and auth method must be define in the provider subscription.

We expect a feedback endpoint with a POST http method that will receive a JSON object with the following structure in success case:

API Contract

OutgoingPlatformsEventsPivot schema
OutgoingPlatformsEventsPivot.ts
{
  "header": {
    "message": string,
    "message_date": string, // UTC date time format "YYYY-MM-DDTHH:MM:SSZ"
    "app" : string // 'E4_3PL'
  },
  "outgoing_event": {
    "issuer": {
      "origin_software": "string" // 'E4_3PL'
    },
    "receiver": {
       "provider": {
          "code": "string", // "MOS"
          "name": "string", // "Mosanada"
          "logistics_company": {
              "code": "string", // "MOS"
              "name": "string", // "Mosanada"
          },
          "contacts": []
      }
    },
    "event": {
      "event_no": "string",
      "type": "string", // 'car_left', 'ready_for_delivery'
      "creation_datetime_utc": string, // UTC date time format "YYYY-MM-DDTHH:MM:SSZ"
      "real_date": {
        "date": "string", // Local date time format "YYYY-MM-DDTHH:MM:SS"
        "utc_date": string, // UTC date time format "YYYY-MM-DDTHH:MM:SSZ"
      },
      "origin_software": "string", // 'E4_4PL'
      "result_code": "string", // 'DONE' or error code
      "result_message": "string" 
    },
    "incoming_event": {
      "event": {
        "x_type": "string", // 'preparation_quality_check_completed'
        "real_date": {
          "date": "string", // Local date time format "YYYY-MM-DDTHH:MM:SS"
        },
        "incoming_site": {
          "check_private": "boolean", 
          "platform": {
            "code": "string" // platform code
          }
        }
      },
      "vin": "string"
    }
  }
}
Example of OutgoingPlatformsEventsPivot Body
JSON
{
    "header": {
        "message_date": "2026-04-17T09:34:04.365Z",
        "message_no": "TO-MOS-20260417-00011",
        "app": "3pl"
    },
    "outgoing_event": {
        "issuer": {
            "origin_software": "E4_3PL"
        },
        "receiver": {
            "provider": {
                "code": "MOS",
                "name": "Mosanada",
                "logistics_company": {
                    "code": "MOS",
                    "name": "Mosanada"
                },
                "contacts": []
            }
        },
        "event": {
            "event_no": "E-MOS-20260417-00042",
            "family": "incoming_event_execution",
            "type": "incoming_event_processed",
            "origin_software": "E4_3PL",
            "real_date": {
                "date": "2026-04-17T09:34:03",
                "utc_date": "2026-04-17T09:34:03.848Z"
            },
            "creation_datetime_utc": "2026-04-17T09:34:03.855Z",
            "comments": [],
            "result_text": "done",
            "result_code": "DONE"
        },
        "incoming_event": {
            "event": {
                "x_type": "preparation_quality_check_completed",
                "real_date": {
                    "date": "2026-04-17T11:34:02"
                },
                "incoming_site": {
                    "check_private": true,
                    "platform": {
                        "code": "KHUMRA"
                    }
                }
            },
            "vin": "WBA11AK08R7R04958"
        }
    }
}
Example of error OutgoingPlatformsEventsPivot Body
JSON
{
    "header": {
        "message_date": "2026-04-17T09:34:04.365Z",
        "message_no": "TO-MOS-20260417-00011",
        "app": "3pl"
    },
    "outgoing_event": {
        "issuer": {
            "origin_software": "E4_3PL"
        },
        "receiver": {
            "provider": {
                "code": "MOS",
                "name": "Mosanada",
                "logistics_company": {
                    "code": "MOS",
                    "name": "Mosanada"
                },
                "contacts": []
            }
        },
        "event": {
            "event_no": "E-MOS-20260417-00042",
            "family": "incoming_event_execution",
            "type": "incoming_event_processed",
            "origin_software": "E4_3PL",
            "real_date": {
                "date": "2026-04-17T09:34:03",
                "utc_date": "2026-04-17T09:34:03.848Z"
            },
            "creation_datetime_utc": "2026-04-17T09:34:03.855Z",
            "comments": [],
            "result_text": "incoming_event_no_order_found",
            "result_code": "ERROR"
        },
        "incoming_event": {
            "event": {
                "x_type": "preparation_quality_check_completed",
                "real_date": {
                    "date": "2026-04-17T11:34:02"
                },
                "incoming_site": {
                    "check_private": true,
                    "platform": {
                        "code": "KHUMRA"
                    }
                }
            },
            "vin": "WBA11AK08R7R04958"
        }
    }
}