v1

latestOpenAPI 3.1.02026-07-1270243932.3 KB

postWebhooktrack

Payload

event'transaction_created' | 'transaction_updated' | 'track_updated' | 'batch_created' | 'batch_purchased' | 'all'

Type of event that triggered the webhook.

testboolean

Determines whether the webhook is a test webhook or not.

Example payload

{
  "data": {
    "address_from": {
      "city": "Las Vegas",
      "country": "US",
      "state": "NV",
      "zip": "89101"
    },
    "address_to": {
      "city": "Las Vegas",
      "country": "US",
      "state": "NV",
      "zip": "89101"
    },
    "carrier": "usps",
    "metadata": "Order 000123",
    "original_eta": "2021-07-23T00:00:00Z",
    "servicelevel": {
      "name": "Priority Mail Express",
      "token": "usps_priority_express",
      "parent_servicelevel": {
        "name": "Priority Mail Express",
        "token": "usps_priority_express"
      }
    },
    "tracking_history": [
      {
        "location": {
          "city": "Las Vegas",
          "country": "US",
          "state": "NV",
          "zip": "89101"
        },
        "status": "DELIVERED",
        "substatus": {
          "code": "information_received",
          "text": "Information about the package received."
        },
        "status_date": "2016-07-23T00:00:00Z",
        "status_details": "Your shipment has been delivered at the destination mailbox."
      }
    ],
    "tracking_number": "9205590164917312751089",
    "tracking_status": {
      "location": {
        "city": "Las Vegas",
        "country": "US",
        "state": "NV",
        "zip": "89101"
      },
      "status": "DELIVERED",
      "substatus": {
        "code": "information_received",
        "text": "Information about the package received."
      },
      "status_date": "2016-07-23T00:00:00Z",
      "status_details": "Your shipment has been delivered at the destination mailbox."
    }
  }
}

Response

The data was successfully received