Skip to main content
WEBHOOK
transaction
{
  "event": "transaction_created",
  "test": true,
  "data": {
    "commercial_invoice_url": "<string>",
    "created_by": {
      "first_name": "Shwan",
      "last_name": "Ippotle",
      "username": "shippotle@shippo.com"
    },
    "eta": "<string>",
    "label_file_type": "PDF_4x6",
    "label_url": "https://shippo-delivery.s3.amazonaws.com/70ae8117ee1749e393f249d5b77c45e0.pdf?Signature=vDw1ltcyGveVR1OQoUDdzC43BY8%3D&Expires=1437093830&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
    "messages": [
      {
        "source": "UPS",
        "code": "carrier_timeout",
        "text": "UPS API did not respond. Please try again in a few minutes."
      }
    ],
    "metadata": "<string>",
    "object_created": "2023-11-07T05:31:56Z",
    "object_id": "915d94940ea54c3a80cbfa328722f5a1",
    "object_owner": "shippotle@shippo.com",
    "object_state": "VALID",
    "object_updated": "2023-11-07T05:31:56Z",
    "parcel": "e94c7fdfdc7b495dbb390a28d929d90a",
    "qr_code_url": "https://shippo-delivery.s3.amazonaws.com/96_qr_code.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
    "rate": {
      "amount": "5.5",
      "amount_local": "5.5",
      "currency": "USD",
      "currency_local": "USD",
      "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
      "provider": "USPS",
      "carrier_account": "078870331023437cb917f5187429b093",
      "servicelevel_name": "Priority Mail",
      "servicelevel_token": "fedex_ground"
    },
    "status": "SUCCESS",
    "test": true,
    "tracking_number": "9499907123456123456781",
    "tracking_status": "DELIVERED",
    "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9499907123456123456781"
  }
}

Authorizations

Authorization
string
header
default:ShippoToken shippo_test_d41a6f04796998570c521a50828eae8e3cccf0eb
required

API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123

Body

application/json

Transaction created or updated

Content of the webhook posted to the external URL

event
enum<string>

Type of event that triggered the webhook.

Available options:
transaction_created,
transaction_updated,
track_updated,
batch_created,
batch_purchased,
all
test
boolean

Determines whether the webhook is a test webhook or not.

data
object

Response

200

The data was successfully received