Sign in

a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Shipments

Shipment Created

Sent when a shipment is created

Required permissions:

  • shipment:basic:read
  • payment:basic:read
  • webhook_receive:shipments
postWebhookshipment.created

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'shipment.created' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "account_id": "biz_xxxxxxxxxxxxxx",
    "carrier": "ups",
    "checkpoints": [
      {
        "location": "PHILADELPHIA, PA",
        "message": "Picked up",
        "status": "in_transit",
        "timestamp": "2026-01-01T12:00:00.000Z"
      }
    ],
    "created_at": "2026-01-01T12:00:00.000Z",
    "id": "ship_xxxxxxxxxxxxxx",
    "payment_id": "pay_xxxxxxxxxxxxxx",
    "status": "in_transit",
    "tracking_number": "1Z999AA10123456784",
    "tracking_url": "https://track.aftership.com/xxxxxxxxxxxxxxxxxx",
    "updated_at": "2026-01-01T12:00:00.000Z"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "shipment.created"
}

Response

Return a 200 status to indicate that the data was received successfully