ValidateInboundData

This method validates and then returns the type of information contained in the inbound data, such as tracking information

Carriers which support webhook based tracking or manifesting updates may choose to implement this endpoint

Note: Changes made to the connection meta-data will not be saved if modified

Request
Request Body schema: application/json

An object containing information sent by the carrier via an inbound data request (e.g. a webhook).

data
string or null

The request's data, e.g. the body of the webhook http request

object or null

Headers sent with the inbound request if it was received via http

transaction_id
required
string <uuid>

The transaction ID uniquely represents this request. If the request is retried then this transaction ID will be the same. You should only perform the requested action once per given transaction ID.

object (Authorization)
object or null
connection_name
string or null

The name of the connection to use, if this app has connection names defined

Responses
200

An object with a list of information contained in the inbound data.

post/ValidateInboundData
Request samples
application/json
{
  • "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
  • "headers": {
    },
  • "transaction_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {
    }
}
Response samples
application/json
{
  • "content_types": [
    ]
}