Webhook Subscriptions

Subscribe to events and receive webhooks at your URLs

In This Article

Before We Begin Good to Know Subscribe to Postsale Webhook Events Create a Webhook Subscription More Than One Webhook Manage Webhook Subscriptions About Webhook Events A Shipment is Processed A Shipment is Voided A Label's Tracking Status Has Changed An Order's Status Has Changed An Order is Imported An Order is Reimported An Order Note is Created An Order Note is Updated An Order Note is Deleted

Reduce delays, eliminate repetitive tasks, and keep your external tools perfectly in sync with Postsale.

Subscribe to webhook events to extend your workflow beyond Postsale by sending real-time data directly to your systems or third-party applications. Receive instant notifications the moment an event occurs, like when an order is imported, a label is created or voided, or a tracking status is updated, without manually checking for updates or relying on scheduled data pulls.

This article will walk you through subscribing to webhook events in Postsale.

Before We Begin

Before creating a webhook subscription in Postsale, make sure you have the following in place:

A publicly accessible webhook URL
This is the endpoint where Postsale will send event data.
A destination endpoint that can receive HTTP requests
Your system should be able to accept and process incoming webhook payloads.
Webhook validation logic (if using a signing secret)
If you enable a signing secret, prepare your internal logic to validate incoming requests using HMAC-SHA256.
A defined list of events to subscribe to
Identify which events you want Postsale to send to your webhook.

Good to Know

When a webhook subscription is created, Postsale sends event data to the URL you provide.
If a signing secret is enabled:
- Each request includes a X-Webhook-Signature header.
- The signature is generated using HMAC-SHA256.
Be sure to copy and securely store your signing secret when it is first displayed.
It will not be shown again.

Create a Webhook Subscription

Procedure: Settings > Account Settings

Go to Settings.
Select Account Settings.

Select Integrations from the left-side menu.
Select Webhooks from the list of available integrations.
Click Add in the Webhook Subscriptions pop-up.
Enter a Name for your webhook subscription.
Enter the webhook URL.
This is the URL to which Postsale will send webhook events.
Check the box for each webhook event to which you wish to subscribe.
For more information on each event, see the About Webhook Events section below.
Click Create.
(Optional) Click Copy to copy the Signing Secret key.
If your webhook connection supports using a Signing Secret, be sure to copy this key now, as it will not be shown again.

If a signing secret is enabled:
- Each request includes an X-Webhook-Signature header.
- The signature is generated using HMAC-SHA256.
Click Done.

The webhook subscription is added and is displayed in the Webhook Subscriptions pop-up. The following information is shown:

Webhook Name
Webhook URL
The subscribed events

The webhook is shown in the webhook subscriptions pop-up.

More Than One Webhook

Do you need to create more than one webhook subscription? Repeat the steps in this section to add additional webhooks.

Manage Webhook Subscriptions

To manage your webhook subscriptions:

Procedure: Settings > Account Settings

Go to Settings.
Select Account Settings.

Select Integrations from the left-side menu.
Select Webhooks from the list of available integrations.

View Delivery Logs

View the delivery log for details about the triggered events for the webhook subscription.

Click the Delivery log icon.

The logs are listed for you and include the following information:

The event
Success status
HTTP response status code
Number of attempts made
The date and time of the event

A log is shown.

Expand the log to view Response and Payload information for the event.

Edit the Webhook Subscription

Click the Edit icon.
Update the webhook as needed.
You can edit:
1. Webhook Name
2. Webhook URL
3. Rotate the Signing Secret - Click the Rotate Secret button to generate a new Signing Secret. The secret will be shown once.
4. Subscribed Events
5. Enable or Disable the Webhook - Useful when you need to disable the webhook, but do not wish to delete it.

The Edit Webhook Subscription screen is open and labeled.

Click Update to save your edits.

Delete a Webhook Subscription

Click the Delete icon.
Be sure you wish to delete the webhook, as it cannot be recovered once deleted.

About Webhook Events

Expand a webhook event below to see an example of the POST payload sent when that event is triggered.

You can also view the actual POST payloads for your webhooks in the event logs in Postsale. See the Manage Webhook Subscriptions section above for more details.

A Shipment is Processed

Event: label_created

Description: The event is triggered when a label is created in Postsale.

Sample POST

{
  "data": {
    "order": {
      "id": "547677cb-9b06-5b76-8f20-5499476a7f58",
      "date": "2026-03-30T12:00:00.000Z",
      "tags": [],
      "items": [
        {
          "id": "beb632ad-0519-4c4d-b629-defd25271466",
          "sku": "DSPT-LG",
          "name": "Dog Saver Promo T-shirt LG",
          "price": 19.99,
          "total": 19.99,
          "weight": 1,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 1,
          "harmonized_code": "",
          "country_of_origin": ""
        },
        {
          "id": "84dfadb7-6572-4b77-872c-422476182596",
          "sku": "BS1",
          "name": "Dog Saver - I saved a Dog Bumper Sticker",
          "price": 2.5,
          "total": 2.5,
          "weight": 0.25,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 0.25,
          "harmonized_code": "",
          "country_of_origin": ""
        }
      ],
      "notes": [],
      "store": {
        "id": "ef22f5b4-23ab-435d-b091-31a5f10a8c59",
        "logo": "2b8a4a59-0c07-4bbb-a004-4a53e760bd3d",
        "name": "Dog Savers Promo",
        "type": "csv",
        "address": {
          "city": "St. Louis",
          "name": "Shipping Department",
          "email": "shipping@email.com",
          "phone": "314-555-5555",
          "state": "MO",
          "company": "STL Dog Savers",
          "postal_code": "63139",
          "country_code": "US",
          "street_line_1": "1940 Hampton Avenue",
          "street_line_2": ""
        }
      },
      "total": 22.49,
      "number": "DS1453",
      "source": "Dog Saver Promo",
      "status": "Voided",
      "charges": [],
      "payment": {
        "id": "01faa93b-f05b-4a71-b9b6-71d0e036e9b2",
        "name": "",
        "amount": 0,
        "details": {}
      },
      "archived": false,
      "subtotal": 22.49,
      "import_id": "bb79eb6f-8ced-4bbd-9180-c886ba0976e2",
      "created_at": "2025-01-08T16:44:33.503Z",
      "import_ids": [
        "9ff0ca00-d386-44a5-91ee-87b0051639be",
        "26347be5-b6d1-4cef-b5a5-8304cd314eb0",
        "4cacee41-6ef7-4009-9a4d-7fe261d404b0",
        "f40ba814-758a-4f81-9c59-1608af103a23",
        "03cce979-87d2-492e-9ad0-3adebf617b6b",
        "ac74cb56-19e9-417a-84d1-ed44e481ab81",
        "e409f8c1-8249-48e8-98f2-424f8e77dddf",
        "0cbae467-7ba3-4aa0-a672-151a62015cd5",
        "ef1e2e8e-39e5-47fc-bc83-0bfc3b79f638",
        "8cbd926f-ec89-493d-9f45-5ae3f78d30ef",
        "930bf7d8-faf8-484f-987c-b655fafa3e1c",
        "1f00a600-60da-4092-b749-ec98d623dd52",
        "58dc5eb3-c3fa-4a98-8167-51ec8aa345fb",
        "fa241adb-6209-414d-bba1-a16b00e933ba",
        "bb79eb6f-8ced-4bbd-9180-c886ba0976e2"
      ],
      "updated_at": "2026-04-23T13:36:40.207Z",
      "bill_address": {
        "id": "4568142d-6029-4833-b6ed-6f086ac5d0c5",
        "city": "Bay City",
        "name": "Calvin Morton",
        "email": "CalvinBMorton@superrito.com",
        "phone": "989-892-6535",
        "state": "MI",
        "company": "Crown Books",
        "postal_code": "48708",
        "country_code": "US",
        "street_line_1": "59 Juniper Drive"
      },
      "ship_address": {
        "id": "166c070f-a975-440c-b41d-ccca434a3ee2",
        "city": "Bay City",
        "name": "Calvin Morton",
        "email": "CalvinBMorton@superrito.com",
        "phone": "989-892-6535",
        "state": "MI",
        "company": "Crown Books",
        "postal_code": "48708",
        "country_code": "US",
        "street_line_1": "59 Juniper Drive"
      },
      "requested_shipping": "Economical"
    },
    "shipments": [
      {
        "id": "c0147942-b3e4-4a66-a437-e61566f4b0ae",
        "labels": [
          {
            "id": "e28c2065-c2da-4210-8b22-4933537c9109",
            "url": "https://s3.amazonaws.com/staging.labels.post.sale.4/005121af-197b-4828-ba42-e4863d4e32e3/d200144f-b1c2-4306-b824-af0eb8d2f992.png",
            "sequence": 0,
            "voidable": true,
            "trackable": true,
            "dimensions": {
              "unit": "in",
              "width": 4,
              "height": 6
            },
            "label_type": "png",
            "total_cost": 6.51,
            "shipment_id": "c0147942-b3e4-4a66-a437-e61566f4b0ae",
            "return_label": false,
            "copies_to_print": 1,
            "tracking_number": "9236190359872500050062",
            "tracking_status": "carrier_awaiting_package",
            "tracking_history": [],
            "carrier_reference": "9236190359872500050062"
          }
        ],
        "status": "processed",
        "carrier": "usps",
        "service": "usps_ground_advantage",
        "domestic": true,
        "packages": [
          {
            "id": "bcd007e7-c0e5-42ec-9b76-183da7106791",
            "value": 22.49,
            "width": 5,
            "height": 4,
            "length": 10,
            "weight": 1,
            "dim_unit": "in",
            "sequence": 0,
            "shipment_id": "c0147942-b3e4-4a66-a437-e61566f4b0ae",
            "weight_unit": "lbs",
            "package_type": "parcel"
          }
        ],
        "insurance": {
          "cost": 0,
          "amount_source": "items",
          "apply_insurance": false,
          "insurance_provider": "shipsurance"
        },
        "reference": "547677cb-9b06-5b76-8f20-5499476a7f58",
        "ship_date": "2026-04-23T13:37:15.229Z",
        "created_at": "2026-04-23T13:36:36.267Z",
        "to_address": {
          "id": "1cccd346-1e27-44af-b3f4-93827859ef2b",
          "city": "Bay City",
          "name": "Calvin Morton",
          "email": "CalvinBMorton@superrito.com",
          "phone": "989-892-6535",
          "state": "MI",
          "company": "Crown Books",
          "postal_code": "48708",
          "residential": false,
          "country_code": "US",
          "street_line_1": "59 Juniper Drive",
          "address_validation": {
            "valid": false,
            "reason": "Invalid address format",
            "original_address_hash": "1afa2e500f60de1938f7e17411a7a240afdb9c40"
          }
        },
        "updated_at": "2026-04-23T13:37:16.961Z",
        "reference_1": "Thank you for your order!",
        "reference_2": "Order # DS1453",
        "confirmation": "none",
        "from_address": {
          "city": "St. Louis",
          "name": "Shipping Department",
          "phone": "555-555-5555",
          "state": "MO",
          "company": "Dog Saver STL",
          "postal_code": "63101",
          "country_code": "US",
          "street_line_1": "1119 North Tucker Boulevard"
        },
        "processed_by": "c0c4e65e-17dc-4c5c-875a-60a991c971fd",
        "processed_date": "2026-04-23T13:37:16.933Z",
        "rate_selection": "economical",
        "from_address_type": "origin_address",
        "origin_address_id": "79570c42-3e5e-4af2-9482-9cf5eed7d0cd",
        "carrier_account_id": "e2fd4547-adaf-4020-a4ec-6236e1ea4a2f",
        "return_shipment_data": {},
        "return_shipment_type": "none",
        "ignore_bad_to_address": true
      }
    ]
  },
  "event": "label_created",
  "timestamp": "2026-04-23T13:37:17.067Z"
}

A Shipment is Voided

Event: label_voided

Description: The event is triggered when a label is voided in Postsale.

{
  "data": {
    "order": {
      "id": "547677cb-9b06-5b76-8f20-5499476a7f58",
      "date": "2026-03-30T12:00:00.000Z",
      "tags": [],
      "items": [
        {
          "id": "beb632ad-0519-4c4d-b629-defd25271466",
          "sku": "DSPT-LG",
          "name": "Dog Saver Promo T-shirt LG",
          "price": 19.99,
          "total": 19.99,
          "weight": 1,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 1,
          "harmonized_code": "",
          "country_of_origin": ""
        },
        {
          "id": "84dfadb7-6572-4b77-872c-422476182596",
          "sku": "BS1",
          "name": "Dog Saver - I saved a Dog Bumper Sticker",
          "price": 2.5,
          "total": 2.5,
          "weight": 0.25,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 0.25,
          "harmonized_code": "",
          "country_of_origin": ""
        }
      ],
      "notes": [],
      "store": {
        "id": "ef22f5b4-23ab-435d-b091-31a5f10a8c59",
        "logo": "2b8a4a59-0c07-4bbb-a004-4a53e760bd3d",
        "name": "Dog Savers Promo",
        "type": "csv",
        "address": {
          "city": "St. Louis",
          "name": "Shipping Department",
          "email": "shipping@email.com",
          "phone": "314-555-5555",
          "state": "MO",
          "company": "STL Dog Savers",
          "postal_code": "63139",
          "country_code": "US",
          "street_line_1": "1940 Hampton Avenue",
          "street_line_2": ""
        }
      },
      "total": 22.49,
      "number": "DS1453",
      "source": "Dog Saver Promo",
      "status": "Shipped",
      "charges": [],
      "payment": {
        "id": "01faa93b-f05b-4a71-b9b6-71d0e036e9b2",
        "name": "",
        "amount": 0,
        "details": {}
      },
      "archived": false,
      "subtotal": 22.49,
      "import_id": "bb79eb6f-8ced-4bbd-9180-c886ba0976e2",
      "created_at": "2025-01-08T16:44:33.503Z",
      "import_ids": [
        "9ff0ca00-d386-44a5-91ee-87b0051639be",
        "26347be5-b6d1-4cef-b5a5-8304cd314eb0",
        "4cacee41-6ef7-4009-9a4d-7fe261d404b0",
        "f40ba814-758a-4f81-9c59-1608af103a23",
        "03cce979-87d2-492e-9ad0-3adebf617b6b",
        "ac74cb56-19e9-417a-84d1-ed44e481ab81",
        "e409f8c1-8249-48e8-98f2-424f8e77dddf",
        "0cbae467-7ba3-4aa0-a672-151a62015cd5",
        "ef1e2e8e-39e5-47fc-bc83-0bfc3b79f638",
        "8cbd926f-ec89-493d-9f45-5ae3f78d30ef",
        "930bf7d8-faf8-484f-987c-b655fafa3e1c",
        "1f00a600-60da-4092-b749-ec98d623dd52",
        "58dc5eb3-c3fa-4a98-8167-51ec8aa345fb",
        "fa241adb-6209-414d-bba1-a16b00e933ba",
        "bb79eb6f-8ced-4bbd-9180-c886ba0976e2"
      ],
      "updated_at": "2026-04-23T13:37:25.004Z",
      "bill_address": {
        "id": "4568142d-6029-4833-b6ed-6f086ac5d0c5",
        "city": "Bay City",
        "name": "Calvin Morton",
        "email": "CalvinBMorton@superrito.com",
        "phone": "989-892-6535",
        "state": "MI",
        "company": "Crown Books",
        "postal_code": "48708",
        "country_code": "US",
        "street_line_1": "59 Juniper Drive"
      },
      "ship_address": {
        "id": "166c070f-a975-440c-b41d-ccca434a3ee2",
        "city": "Bay City",
        "name": "Calvin Morton",
        "email": "CalvinBMorton@superrito.com",
        "phone": "989-892-6535",
        "state": "MI",
        "company": "Crown Books",
        "postal_code": "48708",
        "country_code": "US",
        "street_line_1": "59 Juniper Drive"
      },
      "requested_shipping": "Economical"
    },
    "shipments": [
      {
        "id": "c0147942-b3e4-4a66-a437-e61566f4b0ae",
        "labels": [
          {
            "id": "e28c2065-c2da-4210-8b22-4933537c9109",
            "url": "https://s3.amazonaws.com/staging.labels.post.sale.4/005121af-197b-4828-ba42-e4863d4e32e3/d200144f-b1c2-4306-b824-af0eb8d2f992.png",
            "sequence": 0,
            "voidable": true,
            "trackable": true,
            "dimensions": {
              "unit": "in",
              "width": 4,
              "height": 6
            },
            "label_type": "png",
            "total_cost": 6.51,
            "shipment_id": "c0147942-b3e4-4a66-a437-e61566f4b0ae",
            "return_label": false,
            "copies_to_print": 1,
            "tracking_number": "9236190359872500050062",
            "tracking_status": "carrier_awaiting_package",
            "tracking_history": [],
            "carrier_reference": "9236190359872500050062",
            "last_tracking_event_date": "2026-04-23T13:37:16.934Z"
          }
        ],
        "status": "voided",
        "carrier": "usps",
        "service": "usps_ground_advantage",
        "domestic": true,
        "packages": [
          {
            "id": "bcd007e7-c0e5-42ec-9b76-183da7106791",
            "value": 22.49,
            "width": 5,
            "height": 4,
            "length": 10,
            "weight": 1,
            "dim_unit": "in",
            "sequence": 0,
            "shipment_id": "c0147942-b3e4-4a66-a437-e61566f4b0ae",
            "weight_unit": "lbs",
            "package_type": "parcel"
          }
        ],
        "insurance": {
          "cost": 0,
          "amount_source": "items",
          "apply_insurance": false,
          "insurance_provider": "shipsurance"
        },
        "reference": "547677cb-9b06-5b76-8f20-5499476a7f58",
        "ship_date": "2026-04-23T13:37:15.229Z",
        "void_date": "2026-04-23T13:52:44.766Z",
        "voided_by": "c0c4e65e-17dc-4c5c-875a-60a991c971fd",
        "created_at": "2026-04-23T13:36:36.267Z",
        "to_address": {
          "id": "1cccd346-1e27-44af-b3f4-93827859ef2b",
          "city": "Bay City",
          "name": "Calvin Morton",
          "email": "CalvinBMorton@superrito.com",
          "phone": "989-892-6535",
          "state": "MI",
          "company": "Crown Books",
          "postal_code": "48708",
          "residential": false,
          "country_code": "US",
          "street_line_1": "59 Juniper Drive",
          "address_validation": {
            "valid": false,
            "reason": "Invalid address format",
            "original_address_hash": "1afa2e500f60de1938f7e17411a7a240afdb9c40"
          }
        },
        "updated_at": "2026-04-23T13:52:44.775Z",
        "reference_1": "Thank you for your order!",
        "reference_2": "Order # DS1453",
        "confirmation": "none",
        "from_address": {
          "id": "5c7b75cb-a48e-4b2a-b1b7-e520fa503403",
          "city": "St. Louis",
          "name": "Shipping Department",
          "phone": "555-555-5555",
          "state": "MO",
          "company": "Dog Saver STL",
          "postal_code": "63101",
          "country_code": "US",
          "street_line_1": "1119 North Tucker Boulevard"
        },
        "processed_by": "c0c4e65e-17dc-4c5c-875a-60a991c971fd",
        "processed_date": "2026-04-23T13:37:16.933Z",
        "rate_selection": "economical",
        "from_address_type": "origin_address",
        "origin_address_id": "79570c42-3e5e-4af2-9482-9cf5eed7d0cd",
        "carrier_account_id": "e2fd4547-adaf-4020-a4ec-6236e1ea4a2f",
        "return_shipment_data": {},
        "return_shipment_type": "none",
        "ignore_bad_to_address": true
      }
    ]
  },
  "event": "label_voided",
  "timestamp": "2026-04-23T13:52:45.123Z"
}

A Label's Tracking Status Has Changed

Event: label_tracking_status_changed

Description: The event is triggered when Postsale receives a tracking status update from the shipping provider that created the shipping label.

{
  "data": {
    "order": {
      "id": "547677cb-9b06-5b76-8f20-5499476a7f58",
      "date": "2026-03-30T12:00:00.000Z",
      "tags": [],
      "items": [
        {
          "id": "beb632ad-0519-4c4d-b629-defd25271466",
          "sku": "DSPT-LG",
          "name": "Dog Saver Promo T-shirt LG",
          "price": 19.99,
          "total": 19.99,
          "weight": 1,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 1,
          "harmonized_code": "",
          "country_of_origin": ""
        },
        {
          "id": "84dfadb7-6572-4b77-872c-422476182596",
          "sku": "BS1",
          "name": "Dog Saver - I saved a Dog Bumper Sticker",
          "price": 2.5,
          "total": 2.5,
          "weight": 0.25,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 0.25,
          "harmonized_code": "",
          "country_of_origin": ""
        }
      ],
      "notes": [],
      "store": {
        "id": "ef22f5b4-23ab-435d-b091-31a5f10a8c59",
        "logo": "2b8a4a59-0c07-4bbb-a004-4a53e760bd3d",
        "name": "Dog Savers Promo",
        "type": "csv",
        "address": {
          "city": "St. Louis",
          "name": "Shipping Department",
          "email": "shipping@email.com",
          "phone": "314-555-5555",
          "state": "MO",
          "company": "STL Dog Savers",
          "postal_code": "63139",
          "country_code": "US",
          "street_line_1": "1940 Hampton Avenue",
          "street_line_2": ""
        }
      },
      "total": 22.49,
      "number": "DS1453",
      "source": "Dog Saver Promo",
      "status": "Shipped",
      "charges": [],
      "payment": {
        "id": "01faa93b-f05b-4a71-b9b6-71d0e036e9b2",
        "name": "",
        "amount": 0,
        "details": {}
      },
      "archived": false,
      "subtotal": 22.49,
      "import_id": "bb79eb6f-8ced-4bbd-9180-c886ba0976e2",
      "created_at": "2025-01-08T16:44:33.503Z",
      "import_ids": [
        "9ff0ca00-d386-44a5-91ee-87b0051639be",
        "26347be5-b6d1-4cef-b5a5-8304cd314eb0",
        "4cacee41-6ef7-4009-9a4d-7fe261d404b0",
        "f40ba814-758a-4f81-9c59-1608af103a23",
        "03cce979-87d2-492e-9ad0-3adebf617b6b",
        "ac74cb56-19e9-417a-84d1-ed44e481ab81",
        "e409f8c1-8249-48e8-98f2-424f8e77dddf",
        "0cbae467-7ba3-4aa0-a672-151a62015cd5",
        "ef1e2e8e-39e5-47fc-bc83-0bfc3b79f638",
        "8cbd926f-ec89-493d-9f45-5ae3f78d30ef",
        "930bf7d8-faf8-484f-987c-b655fafa3e1c",
        "1f00a600-60da-4092-b749-ec98d623dd52",
        "58dc5eb3-c3fa-4a98-8167-51ec8aa345fb",
        "fa241adb-6209-414d-bba1-a16b00e933ba",
        "bb79eb6f-8ced-4bbd-9180-c886ba0976e2"
      ],
      "updated_at": "2026-04-23T14:05:00.732Z",
      "bill_address": {
        "id": "4568142d-6029-4833-b6ed-6f086ac5d0c5",
        "city": "Bay City",
        "name": "Calvin Morton",
        "email": "CalvinBMorton@superrito.com",
        "phone": "989-892-6535",
        "state": "MI",
        "company": "Crown Books",
        "postal_code": "48708",
        "country_code": "US",
        "street_line_1": "59 Juniper Drive"
      },
      "ship_address": {
        "id": "166c070f-a975-440c-b41d-ccca434a3ee2",
        "city": "Bay City",
        "name": "Calvin Morton",
        "email": "CalvinBMorton@superrito.com",
        "phone": "989-892-6535",
        "state": "MI",
        "company": "Crown Books",
        "postal_code": "48708",
        "country_code": "US",
        "street_line_1": "59 Juniper Drive"
      },
      "requested_shipping": "Economical"
    },
    "shipments": [
      {
        "id": "5eb42894-b62b-4083-a5ed-ec479061a730",
        "labels": [
          {
            "id": "e948dc4d-a29c-419e-a484-0d29eb8f3a54",
            "url": "https://s3.amazonaws.com/staging.labels.post.sale.4/db07e461-fc09-48b2-81a2-c75b1c4662e1/e9c3e725-2870-46be-9a52-4513d1ad2742.png",
            "sequence": 0,
            "voidable": true,
            "trackable": true,
            "dimensions": {
              "unit": "in",
              "width": 4,
              "height": 6
            },
            "label_type": "png",
            "total_cost": 6.51,
            "shipment_id": "5eb42894-b62b-4083-a5ed-ec479061a730",
            "return_label": false,
            "copies_to_print": 1,
            "tracking_number": "9236190359872500050079",
            "tracking_status": "in_transit",
            "tracking_history": [],
            "carrier_reference": "9236190359872500050079",
            "last_tracking_event_date": "2026-04-23T14:04:57.425Z"
          }
        ],
        "status": "processed",
        "carrier": "usps",
        "service": "usps_ground_advantage",
        "domestic": true,
        "packages": [
          {
            "id": "81f697fc-8bdc-439a-a7fb-34bf1bc309b9",
            "value": 22.49,
            "width": 5,
            "height": 4,
            "length": 10,
            "weight": 1,
            "dim_unit": "in",
            "sequence": 0,
            "shipment_id": "5eb42894-b62b-4083-a5ed-ec479061a730",
            "weight_unit": "lbs",
            "package_type": "parcel"
          }
        ],
        "insurance": {
          "cost": 0,
          "amount_source": "items",
          "apply_insurance": false,
          "insurance_provider": "shipsurance"
        },
        "reference": "547677cb-9b06-5b76-8f20-5499476a7f58",
        "ship_date": "2026-04-23T14:04:55.389Z",
        "created_at": "2026-04-23T14:04:25.387Z",
        "to_address": {
          "id": "20207fcf-20fd-42c2-91fa-47b7aa9fd5e0",
          "city": "Bay City",
          "name": "Calvin Morton",
          "email": "CalvinBMorton@superrito.com",
          "phone": "989-892-6535",
          "state": "MI",
          "company": "Crown Books",
          "postal_code": "48708",
          "residential": false,
          "country_code": "US",
          "street_line_1": "59 Juniper Drive",
          "address_validation": {
            "valid": false,
            "reason": "Invalid address format",
            "original_address_hash": "1afa2e500f60de1938f7e17411a7a240afdb9c40"
          }
        },
        "updated_at": "2026-04-23T14:04:57.446Z",
        "reference_1": "Thank you for your order!",
        "reference_2": "Order # DS1453",
        "confirmation": "none",
        "from_address": {
          "id": "76a43c0d-bb34-486c-b1cb-293d82cab0ec",
          "city": "St. Louis",
          "name": "Shipping Department",
          "phone": "555-555-5555",
          "state": "MO",
          "company": "Dog Saver STL",
          "postal_code": "63101",
          "country_code": "US",
          "street_line_1": "1119 North Tucker Boulevard"
        },
        "processed_by": "c0c4e65e-17dc-4c5c-875a-60a991c971fd",
        "processed_date": "2026-04-23T14:04:57.424Z",
        "rate_selection": "economical",
        "from_address_type": "origin_address",
        "origin_address_id": "79570c42-3e5e-4af2-9482-9cf5eed7d0cd",
        "carrier_account_id": "e2fd4547-adaf-4020-a4ec-6236e1ea4a2f",
        "return_shipment_data": {},
        "return_shipment_type": "none",
        "ignore_bad_to_address": true
      }
    ]
  },
  "event": "label_tracking_status_changed",
  "timestamp": "2026-04-23T14:05:01.319Z"
}

An Order's Status Has Changed

Event: order_status_changed

Description: The event is triggered when an order's status changes.

{
  "data": {
    "order": {
      "id": "547677cb-9b06-5b76-8f20-5499476a7f58",
      "date": "2026-03-30T12:00:00.000Z",
      "tags": [],
      "items": [
        {
          "id": "beb632ad-0519-4c4d-b629-defd25271466",
          "sku": "DSPT-LG",
          "name": "Dog Saver Promo T-shirt LG",
          "price": 19.99,
          "total": 19.99,
          "weight": 1,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 1,
          "harmonized_code": "",
          "country_of_origin": ""
        },
        {
          "id": "84dfadb7-6572-4b77-872c-422476182596",
          "sku": "BS1",
          "name": "Dog Saver - I saved a Dog Bumper Sticker",
          "price": 2.5,
          "total": 2.5,
          "weight": 0.25,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 0.25,
          "harmonized_code": "",
          "country_of_origin": ""
        }
      ],
      "notes": [],
      "store": {
        "id": "ef22f5b4-23ab-435d-b091-31a5f10a8c59",
        "logo": "2b8a4a59-0c07-4bbb-a004-4a53e760bd3d",
        "name": "Dog Savers Promo",
        "type": "csv",
        "address": {
          "city": "St. Louis",
          "name": "Shipping Department",
          "email": "shipping@email.com",
          "phone": "314-555-5555",
          "state": "MO",
          "company": "STL Dog Savers",
          "postal_code": "63139",
          "country_code": "US",
          "street_line_1": "1940 Hampton Avenue",
          "street_line_2": ""
        }
      },
      "total": 22.49,
      "number": "DS1453",
      "source": "Dog Saver Promo",
      "status": "Shipped",
      "charges": [],
      "payment": {
        "id": "01faa93b-f05b-4a71-b9b6-71d0e036e9b2",
        "name": "",
        "amount": 0,
        "details": {}
      },
      "archived": false,
      "subtotal": 22.49,
      "import_id": "bb79eb6f-8ced-4bbd-9180-c886ba0976e2",
      "created_at": "2025-01-08T16:44:33.503Z",
      "import_ids": [
        "9ff0ca00-d386-44a5-91ee-87b0051639be",
        "26347be5-b6d1-4cef-b5a5-8304cd314eb0",
        "4cacee41-6ef7-4009-9a4d-7fe261d404b0",
        "f40ba814-758a-4f81-9c59-1608af103a23",
        "03cce979-87d2-492e-9ad0-3adebf617b6b",
        "ac74cb56-19e9-417a-84d1-ed44e481ab81",
        "e409f8c1-8249-48e8-98f2-424f8e77dddf",
        "0cbae467-7ba3-4aa0-a672-151a62015cd5",
        "ef1e2e8e-39e5-47fc-bc83-0bfc3b79f638",
        "8cbd926f-ec89-493d-9f45-5ae3f78d30ef",
        "930bf7d8-faf8-484f-987c-b655fafa3e1c",
        "1f00a600-60da-4092-b749-ec98d623dd52",
        "58dc5eb3-c3fa-4a98-8167-51ec8aa345fb",
        "fa241adb-6209-414d-bba1-a16b00e933ba",
        "bb79eb6f-8ced-4bbd-9180-c886ba0976e2"
      ],
      "updated_at": "2026-04-23T14:05:00.732Z",
      "bill_address": {
        "id": "4568142d-6029-4833-b6ed-6f086ac5d0c5",
        "city": "Bay City",
        "name": "Calvin Morton",
        "email": "CalvinBMorton@superrito.com",
        "phone": "989-892-6535",
        "state": "MI",
        "company": "Crown Books",
        "postal_code": "48708",
        "country_code": "US",
        "street_line_1": "59 Juniper Drive"
      },
      "ship_address": {
        "id": "166c070f-a975-440c-b41d-ccca434a3ee2",
        "city": "Bay City",
        "name": "Calvin Morton",
        "email": "CalvinBMorton@superrito.com",
        "phone": "989-892-6535",
        "state": "MI",
        "company": "Crown Books",
        "postal_code": "48708",
        "country_code": "US",
        "street_line_1": "59 Juniper Drive"
      },
      "requested_shipping": "Economical"
    },
    "shipments": [
      {
        "id": "5eb42894-b62b-4083-a5ed-ec479061a730",
        "labels": [
          {
            "id": "e948dc4d-a29c-419e-a484-0d29eb8f3a54",
            "url": "https://s3.amazonaws.com/staging.labels.post.sale.4/db07e461-fc09-48b2-81a2-c75b1c4662e1/e9c3e725-2870-46be-9a52-4513d1ad2742.png",
            "sequence": 0,
            "voidable": true,
            "trackable": true,
            "dimensions": {
              "unit": "in",
              "width": 4,
              "height": 6
            },
            "label_type": "png",
            "total_cost": 6.51,
            "shipment_id": "5eb42894-b62b-4083-a5ed-ec479061a730",
            "return_label": false,
            "copies_to_print": 1,
            "tracking_number": "9236190359872500050079",
            "tracking_status": "carrier_awaiting_package",
            "tracking_history": [],
            "carrier_reference": "9236190359872500050079",
            "last_tracking_event_date": "2026-04-23T14:04:57.425Z"
          }
        ],
        "status": "processed",
        "carrier": "usps",
        "service": "usps_ground_advantage",
        "domestic": true,
        "packages": [
          {
            "id": "81f697fc-8bdc-439a-a7fb-34bf1bc309b9",
            "value": 22.49,
            "width": 5,
            "height": 4,
            "length": 10,
            "weight": 1,
            "dim_unit": "in",
            "sequence": 0,
            "shipment_id": "5eb42894-b62b-4083-a5ed-ec479061a730",
            "weight_unit": "lbs",
            "package_type": "parcel"
          }
        ],
        "insurance": {
          "cost": 0,
          "amount_source": "items",
          "apply_insurance": false,
          "insurance_provider": "shipsurance"
        },
        "reference": "547677cb-9b06-5b76-8f20-5499476a7f58",
        "ship_date": "2026-04-23T14:04:55.389Z",
        "created_at": "2026-04-23T14:04:25.387Z",
        "to_address": {
          "id": "20207fcf-20fd-42c2-91fa-47b7aa9fd5e0",
          "city": "Bay City",
          "name": "Calvin Morton",
          "email": "CalvinBMorton@superrito.com",
          "phone": "989-892-6535",
          "state": "MI",
          "company": "Crown Books",
          "postal_code": "48708",
          "residential": false,
          "country_code": "US",
          "street_line_1": "59 Juniper Drive",
          "address_validation": {
            "valid": false,
            "reason": "Invalid address format",
            "original_address_hash": "1afa2e500f60de1938f7e17411a7a240afdb9c40"
          }
        },
        "updated_at": "2026-04-23T14:04:57.446Z",
        "reference_1": "Thank you for your order!",
        "reference_2": "Order # DS1453",
        "confirmation": "none",
        "from_address": {
          "id": "76a43c0d-bb34-486c-b1cb-293d82cab0ec",
          "city": "St. Louis",
          "name": "Shipping Department",
          "phone": "555-555-5555",
          "state": "MO",
          "company": "Dog Saver STL",
          "postal_code": "63101",
          "country_code": "US",
          "street_line_1": "1119 North Tucker Boulevard"
        },
        "processed_by": "c0c4e65e-17dc-4c5c-875a-60a991c971fd",
        "processed_date": "2026-04-23T14:04:57.424Z",
        "rate_selection": "economical",
        "from_address_type": "origin_address",
        "origin_address_id": "79570c42-3e5e-4af2-9482-9cf5eed7d0cd",
        "carrier_account_id": "e2fd4547-adaf-4020-a4ec-6236e1ea4a2f",
        "return_shipment_data": {},
        "return_shipment_type": "none",
        "ignore_bad_to_address": true
      }
    ]
  },
  "event": "order_status_changed",
  "timestamp": "2026-04-23T14:05:01.319Z"
}

An Order is Imported

Event: order_imported

Description: The event is triggered when an order is imported into Postsale for the first time.

{
  "data": {
    "order": {
      "id": "ab1b7cc8-acdb-57a5-9d9a-ffb01b6b02ba",
      "date": "2025-01-01T12:00:00.000Z",
      "tags": [],
      "items": [
        {
          "id": "3ae53a2f-48b8-46bf-969c-7a910bf68ca1",
          "sku": "DSPT-XL",
          "name": "Dog Saver Promo T-shirt XL",
          "price": 19.95,
          "weight": 1,
          "quantity": 1,
          "weight_unit": "lbs",
          "harmonized_code": "",
          "country_of_origin": ""
        },
        {
          "id": "2572f809-a34a-4ecf-8ac0-08e36dd077f3",
          "sku": "BS1",
          "name": "Dog Saver - I saved a Dog Bumper Sticker",
          "price": 2.5,
          "weight": 0.25,
          "quantity": 1,
          "weight_unit": "lbs",
          "harmonized_code": "",
          "country_of_origin": ""
        }
      ],
      "notes": [],
      "store": {
        "id": "ef22f5b4-23ab-435d-b091-31a5f10a8c59",
        "name": "Dog Savers Promo",
        "type": "csv"
      },
      "total": 22.45,
      "number": "DS2500",
      "source": "Widget Me This",
      "status": "Ready to Ship",
      "charges": [],
      "archived": false,
      "import_id": "6227dded-c1fd-4bba-aea0-1c13267c8b7e",
      "import_ids": [
        "6227dded-c1fd-4bba-aea0-1c13267c8b7e"
      ],
      "bill_address": {
        "city": "St. Louis",
        "name": "Sara Green",
        "email": "SaraRGreen@gustr.com",
        "phone": "814-340-8725",
        "state": "MO",
        "company": "Northern Reflections",
        "postal_code": "63101",
        "country_code": "US",
        "street_line_1": "1119 N Tucker Blvd"
      },
      "ship_address": {
        "city": "St. Louis",
        "name": "Sara Green",
        "email": "SaraRGreen@gustr.com",
        "phone": "814-340-8725",
        "state": "MO",
        "company": "Northern Reflections",
        "postal_code": "63101",
        "country_code": "US",
        "street_line_1": "1119 N Tucker Blvd"
      },
      "requested_shipping": "Economical"
    },
    "shipments": []
  },
  "event": "order_imported",
  "timestamp": "2026-04-23T14:19:02.942Z"
}

An Order is Reimported

Event: order_reimported

Description: The event is triggered when an order that is already in Postsale is reimported.

{
  "data": {
    "order": {
      "id": "ad009acd-6126-57a1-90a7-993ec6d6df3b",
      "date": "2025-01-02T12:00:00.000Z",
      "tags": [],
      "items": [
        {
          "id": "2d7e1fa9-db08-4e47-b38b-5760a3b0b65e",
          "sku": "DSPT-SM",
          "name": "Dog Saver Promo T-shirt SM",
          "price": 19.95,
          "total": 39.9,
          "weight": 2,
          "quantity": 2,
          "weight_unit": "lbs",
          "total_weight": 4,
          "harmonized_code": "",
          "country_of_origin": ""
        },
        {
          "id": "c8388bc3-7f01-413d-ad94-591690b0798c",
          "sku": "BS1",
          "name": "Dog Saver - I saved a Dog Bumper Sticker",
          "price": 2.5,
          "total": 2.5,
          "weight": 0.25,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 0.25,
          "harmonized_code": "",
          "country_of_origin": ""
        }
      ],
      "notes": [],
      "store": {
        "id": "ef22f5b4-23ab-435d-b091-31a5f10a8c59",
        "name": "Dog Savers Promo",
        "type": "csv"
      },
      "total": 42.4,
      "number": "DS2501",
      "source": "Dog Saver Promo",
      "status": "Ready to Ship",
      "charges": [],
      "archived": false,
      "subtotal": 42.4,
      "import_id": "28309eb7-c1c1-4380-8bb5-ece9035bca30",
      "import_ids": [
        "6227dded-c1fd-4bba-aea0-1c13267c8b7e",
        "28309eb7-c1c1-4380-8bb5-ece9035bca30"
      ],
      "bill_address": {
        "id": "617b0ea3-1a9a-485e-aad9-d8cf99e151b9",
        "city": "Chicago",
        "name": "Loretta Shupe",
        "email": "LorettaDShupe@dayrep.com",
        "phone": "917-942-0541",
        "state": "IL",
        "company": "STM Auto Parts",
        "postal_code": "60607",
        "country_code": "US",
        "street_line_1": "1035 W Randolph St"
      },
      "ship_address": {
        "id": "3c25ab3e-82fa-4367-96d3-2d4d18a917fe",
        "city": "Chicago",
        "name": "Loretta Shupe",
        "email": "LorettaDShupe@dayrep.com",
        "phone": "917-942-0541",
        "state": "IL",
        "company": "STM Auto Parts",
        "postal_code": "60607",
        "country_code": "US",
        "street_line_1": "1035 W Randolph St"
      },
      "requested_shipping": "Economical"
    },
    "shipments": [
      {
        "id": "ba599fbd-2406-4b08-b65d-c79067c1b2cd",
        "status": "unprocessed",
        "carrier": "usps",
        "service": "usps_ground_advantage",
        "domestic": true,
        "packages": [
          {
            "id": "2ac5821f-6597-4080-9459-2a7bec487484",
            "width": 8,
            "height": 2,
            "length": 10,
            "weight": 1.25,
            "dim_unit": "in",
            "sequence": 0,
            "shipment_id": "ba599fbd-2406-4b08-b65d-c79067c1b2cd",
            "weight_unit": "lbs",
            "package_type": "parcel"
          }
        ],
        "insurance": {
          "cost": 0,
          "amount_source": "items",
          "apply_insurance": false,
          "insurance_provider": "shipsurance"
        },
        "reference": "ad009acd-6126-57a1-90a7-993ec6d6df3b",
        "ship_date": "2026-04-23T14:19:14.116Z",
        "created_at": "2026-04-23T14:19:11.287Z",
        "to_address": {
          "id": "e4d3bde1-e871-4d10-bbfb-a707e4701bef",
          "city": "Chicago",
          "name": "Loretta Shupe",
          "email": "LorettaDShupe@dayrep.com",
          "phone": "917-942-0541",
          "state": "IL",
          "company": "STM Auto Parts",
          "postal_code": "60607",
          "residential": "using_address_validation",
          "country_code": "US",
          "street_line_1": "1035 W Randolph St",
          "address_validation": {
            "valid": true,
            "residential": false,
            "standardized": {
              "city": "CHICAGO",
              "name": "Loretta Shupe",
              "state": "IL",
              "postal_code": "60607-2253",
              "country_code": "US",
              "street_line_1": "1035 W RANDOLPH ST",
              "street_line_2": ""
            },
            "original_address_hash": "05fc4609f3088621f2c4b9fa88ed963d8e55bdb7"
          }
        },
        "updated_at": "2026-04-23T14:19:14.116Z",
        "reference_1": "",
        "reference_2": "",
        "confirmation": "none",
        "rate_selection": "manual",
        "from_address_type": "origin_address",
        "origin_address_id": "7a67d35a-3959-42fd-8374-8766ad5672f1",
        "return_shipment_data": {},
        "return_shipment_type": "include_return_label",
        "ignore_bad_to_address": false
      }
    ]
  },
  "event": "order_reimported",
  "timestamp": "2026-04-23T14:36:41.790Z"
}

An Order Note is Created

Event: order_note_created

Description: The event is triggered when a new order note is created.

{
  "data": {
    "note": {
      "id": "66681f99-9e1d-4cb8-84ef-5fca409bba96",
      "after": {
        "id": "66681f99-9e1d-4cb8-84ef-5fca409bba96",
        "date": "2026-04-23T14:40:11.768Z",
        "content": "Customer requested to expedite the order, please.",
        "updated_at": "2026-04-23T14:40:39.234Z"
      }
    },
    "order": {
      "id": "ab1b7cc8-acdb-57a5-9d9a-ffb01b6b02ba",
      "date": "2025-01-01T12:00:00.000Z",
      "tags": [],
      "items": [
        {
          "id": "2572f809-a34a-4ecf-8ac0-08e36dd077f3",
          "sku": "BS1",
          "name": "Dog Saver - I saved a Dog Bumper Sticker",
          "price": 2.5,
          "total": 2.5,
          "weight": 0.25,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 0.25,
          "harmonized_code": "",
          "country_of_origin": ""
        },
        {
          "id": "3ae53a2f-48b8-46bf-969c-7a910bf68ca1",
          "sku": "DSPT-XL",
          "name": "Dog Saver Promo T-shirt XL",
          "price": 19.95,
          "total": 39.9,
          "weight": 2,
          "quantity": 2,
          "weight_unit": "lbs",
          "total_weight": 4,
          "harmonized_code": "",
          "country_of_origin": ""
        }
      ],
      "notes": [
        {
          "id": "66681f99-9e1d-4cb8-84ef-5fca409bba96",
          "date": "2026-04-23T14:40:11.768Z",
          "content": "Customer requested to expedite the order, please.",
          "updated_at": "2026-04-23T14:40:42.462Z"
        }
      ],
      "store": {
        "id": "ef22f5b4-23ab-435d-b091-31a5f10a8c59",
        "logo": "2b8a4a59-0c07-4bbb-a004-4a53e760bd3d",
        "name": "Dog Savers Promo",
        "type": "csv",
        "address": {
          "city": "St. Louis",
          "name": "Shipping Department",
          "email": "shipping@email.com",
          "phone": "314-555-5555",
          "state": "MO",
          "company": "STL Dog Savers",
          "postal_code": "63139",
          "country_code": "US",
          "street_line_1": "1940 Hampton Avenue",
          "street_line_2": ""
        }
      },
      "total": 42.4,
      "number": "DS2500",
      "source": "Widget Me This",
      "status": "Ready to Ship",
      "charges": [],
      "payment": {
        "id": "42630d63-6177-4bb2-bd95-87da6b8e89cf",
        "name": "",
        "amount": 0,
        "details": {}
      },
      "archived": false,
      "subtotal": 42.4,
      "import_id": "28309eb7-c1c1-4380-8bb5-ece9035bca30",
      "created_at": "2026-04-23T14:19:01.846Z",
      "import_ids": [
        "6227dded-c1fd-4bba-aea0-1c13267c8b7e",
        "28309eb7-c1c1-4380-8bb5-ece9035bca30"
      ],
      "updated_at": "2026-04-23T14:40:42.462Z",
      "bill_address": {
        "id": "991bd6bb-d9f6-4f81-bb5d-467fa923927d",
        "city": "St. Louis",
        "name": "Sara Green",
        "email": "SaraRGreen@gustr.com",
        "phone": "814-340-8725",
        "state": "MO",
        "company": "Northern Reflections",
        "postal_code": "63101",
        "country_code": "US",
        "street_line_1": "1119 N Tucker Blvd"
      },
      "ship_address": {
        "id": "2c40dacd-6d07-47ae-8ff4-76128936f0e5",
        "city": "St. Louis",
        "name": "Sara Green",
        "email": "SaraRGreen@gustr.com",
        "phone": "814-340-8725",
        "state": "MO",
        "company": "Northern Reflections",
        "postal_code": "63101",
        "country_code": "US",
        "street_line_1": "1119 N Tucker Blvd"
      },
      "requested_shipping": "Economical"
    },
    "shipments": [
      {
        "id": "0adabbf7-0909-4fd0-afa8-257970ce6732",
        "status": "unprocessed",
        "carrier": "usps",
        "service": "usps_ground_advantage",
        "domestic": true,
        "packages": [
          {
            "id": "a41164e4-a743-49ad-ab34-fd6e5df6dad7",
            "value": 42.4,
            "width": 8,
            "height": 2,
            "length": 10,
            "weight": 1.25,
            "dim_unit": "in",
            "sequence": 0,
            "shipment_id": "0adabbf7-0909-4fd0-afa8-257970ce6732",
            "weight_unit": "lbs",
            "package_type": "parcel"
          }
        ],
        "insurance": {
          "cost": 0,
          "amount_source": "items",
          "apply_insurance": false,
          "insurance_provider": "shipsurance"
        },
        "reference": "ab1b7cc8-acdb-57a5-9d9a-ffb01b6b02ba",
        "ship_date": "2026-04-23T14:36:45.930Z",
        "created_at": "2026-04-23T14:19:11.079Z",
        "to_address": {
          "id": "414883c2-d9ac-4709-abf7-e32f9343b0b8",
          "city": "St. Louis",
          "name": "Sara Green",
          "email": "SaraRGreen@gustr.com",
          "phone": "814-340-8725",
          "state": "MO",
          "company": "Northern Reflections",
          "postal_code": "63101",
          "residential": "using_address_validation",
          "country_code": "US",
          "street_line_1": "1119 N Tucker Blvd",
          "address_validation": {
            "valid": true,
            "residential": false,
            "standardized": {
              "city": "SAINT LOUIS",
              "name": "Sara Green",
              "state": "MO",
              "postal_code": "63101-1027",
              "country_code": "US",
              "street_line_1": "1119 N TUCKER BLVD",
              "street_line_2": ""
            },
            "original_address_hash": "2e1b1a45f30621d92711f2b00052784f71809c3c"
          }
        },
        "updated_at": "2026-04-23T14:36:45.930Z",
        "reference_1": "",
        "reference_2": "",
        "confirmation": "none",
        "rate_selection": "manual",
        "from_address_type": "origin_address",
        "origin_address_id": "7a67d35a-3959-42fd-8374-8766ad5672f1",
        "return_shipment_data": {},
        "return_shipment_type": "include_return_label"
      }
    ]
  },
  "event": "order_note_created",
  "timestamp": "2026-04-23T14:40:42.971Z"
}

An Order Note is Updated

Event: order_note_updated

Description: The event is triggered when an existing order note is updated.

{
  "data": {
    "note": {
      "id": "66681f99-9e1d-4cb8-84ef-5fca409bba96",
      "after": {
        "id": "66681f99-9e1d-4cb8-84ef-5fca409bba96",
        "date": "2026-04-23T14:40:11.768Z",
        "content": "Customer requested to expedite the order, please. Ship via Next Day Saver.",
        "updated_at": "2026-04-23T14:43:55.949Z"
      },
      "before": {
        "id": "66681f99-9e1d-4cb8-84ef-5fca409bba96",
        "date": "2026-04-23T14:40:11.768Z",
        "content": "Customer requested to expedite the order, please.",
        "updated_at": "2026-04-23T14:40:42.462Z"
      }
    },
    "order": {
      "id": "ab1b7cc8-acdb-57a5-9d9a-ffb01b6b02ba",
      "date": "2025-01-01T12:00:00.000Z",
      "tags": [],
      "items": [
        {
          "id": "2572f809-a34a-4ecf-8ac0-08e36dd077f3",
          "sku": "BS1",
          "name": "Dog Saver - I saved a Dog Bumper Sticker",
          "price": 2.5,
          "total": 2.5,
          "weight": 0.25,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 0.25,
          "harmonized_code": "",
          "country_of_origin": ""
        },
        {
          "id": "3ae53a2f-48b8-46bf-969c-7a910bf68ca1",
          "sku": "DSPT-XL",
          "name": "Dog Saver Promo T-shirt XL",
          "price": 19.95,
          "total": 39.9,
          "weight": 2,
          "quantity": 2,
          "weight_unit": "lbs",
          "total_weight": 4,
          "harmonized_code": "",
          "country_of_origin": ""
        }
      ],
      "notes": [
        {
          "id": "66681f99-9e1d-4cb8-84ef-5fca409bba96",
          "date": "2026-04-23T14:40:11.768Z",
          "content": "Customer requested to expedite the order, please. Ship via Next Day Saver.",
          "updated_at": "2026-04-23T14:43:58.262Z"
        }
      ],
      "store": {
        "id": "ef22f5b4-23ab-435d-b091-31a5f10a8c59",
        "logo": "2b8a4a59-0c07-4bbb-a004-4a53e760bd3d",
        "name": "Dog Savers Promo",
        "type": "csv",
        "address": {
          "city": "St. Louis",
          "name": "Shipping Department",
          "email": "shipping@email.com",
          "phone": "314-555-5555",
          "state": "MO",
          "company": "STL Dog Savers",
          "postal_code": "63139",
          "country_code": "US",
          "street_line_1": "1940 Hampton Avenue",
          "street_line_2": ""
        }
      },
      "total": 42.4,
      "number": "DS2500",
      "source": "Widget Me This",
      "status": "Ready to Ship",
      "charges": [],
      "payment": {
        "id": "42630d63-6177-4bb2-bd95-87da6b8e89cf",
        "name": "",
        "amount": 0,
        "details": {}
      },
      "archived": false,
      "subtotal": 42.4,
      "import_id": "28309eb7-c1c1-4380-8bb5-ece9035bca30",
      "created_at": "2026-04-23T14:19:01.846Z",
      "import_ids": [
        "6227dded-c1fd-4bba-aea0-1c13267c8b7e",
        "28309eb7-c1c1-4380-8bb5-ece9035bca30"
      ],
      "updated_at": "2026-04-23T14:43:58.262Z",
      "bill_address": {
        "id": "991bd6bb-d9f6-4f81-bb5d-467fa923927d",
        "city": "St. Louis",
        "name": "Sara Green",
        "email": "SaraRGreen@gustr.com",
        "phone": "814-340-8725",
        "state": "MO",
        "company": "Northern Reflections",
        "postal_code": "63101",
        "country_code": "US",
        "street_line_1": "1119 N Tucker Blvd"
      },
      "ship_address": {
        "id": "2c40dacd-6d07-47ae-8ff4-76128936f0e5",
        "city": "St. Louis",
        "name": "Sara Green",
        "email": "SaraRGreen@gustr.com",
        "phone": "814-340-8725",
        "state": "MO",
        "company": "Northern Reflections",
        "postal_code": "63101",
        "country_code": "US",
        "street_line_1": "1119 N Tucker Blvd"
      },
      "requested_shipping": "Economical"
    },
    "shipments": [
      {
        "id": "0adabbf7-0909-4fd0-afa8-257970ce6732",
        "status": "unprocessed",
        "carrier": "usps",
        "service": "usps_ground_advantage",
        "domestic": true,
        "packages": [
          {
            "id": "a41164e4-a743-49ad-ab34-fd6e5df6dad7",
            "value": 42.4,
            "width": 8,
            "height": 2,
            "length": 10,
            "weight": 1.25,
            "dim_unit": "in",
            "sequence": 0,
            "shipment_id": "0adabbf7-0909-4fd0-afa8-257970ce6732",
            "weight_unit": "lbs",
            "package_type": "parcel"
          }
        ],
        "insurance": {
          "cost": 0,
          "amount_source": "items",
          "apply_insurance": false,
          "insurance_provider": "shipsurance"
        },
        "reference": "ab1b7cc8-acdb-57a5-9d9a-ffb01b6b02ba",
        "ship_date": "2026-04-23T14:36:45.930Z",
        "created_at": "2026-04-23T14:19:11.079Z",
        "to_address": {
          "id": "414883c2-d9ac-4709-abf7-e32f9343b0b8",
          "city": "St. Louis",
          "name": "Sara Green",
          "email": "SaraRGreen@gustr.com",
          "phone": "814-340-8725",
          "state": "MO",
          "company": "Northern Reflections",
          "postal_code": "63101",
          "residential": "using_address_validation",
          "country_code": "US",
          "street_line_1": "1119 N Tucker Blvd",
          "address_validation": {
            "valid": true,
            "residential": false,
            "standardized": {
              "city": "SAINT LOUIS",
              "name": "Sara Green",
              "state": "MO",
              "postal_code": "63101-1027",
              "country_code": "US",
              "street_line_1": "1119 N TUCKER BLVD",
              "street_line_2": ""
            },
            "original_address_hash": "2e1b1a45f30621d92711f2b00052784f71809c3c"
          }
        },
        "updated_at": "2026-04-23T14:36:45.930Z",
        "reference_1": "",
        "reference_2": "",
        "confirmation": "none",
        "rate_selection": "manual",
        "from_address_type": "origin_address",
        "origin_address_id": "7a67d35a-3959-42fd-8374-8766ad5672f1",
        "return_shipment_data": {},
        "return_shipment_type": "include_return_label"
      }
    ]
  },
  "event": "order_note_updated",
  "timestamp": "2026-04-23T14:43:59.170Z"
}

An Order Note is Deleted

Event: order_note_deleted

Description: The event is triggered when an existing order note is deleted.

{
  "data": {
    "note": {
      "id": "66681f99-9e1d-4cb8-84ef-5fca409bba96",
      "before": {
        "id": "66681f99-9e1d-4cb8-84ef-5fca409bba96",
        "date": "2026-04-23T14:40:11.768Z",
        "content": "Customer requested to expedite the order, please. Ship via Next Day Saver.",
        "updated_at": "2026-04-23T14:43:58.262Z"
      }
    },
    "order": {
      "id": "ab1b7cc8-acdb-57a5-9d9a-ffb01b6b02ba",
      "date": "2025-01-01T12:00:00.000Z",
      "tags": [],
      "items": [
        {
          "id": "2572f809-a34a-4ecf-8ac0-08e36dd077f3",
          "sku": "BS1",
          "name": "Dog Saver - I saved a Dog Bumper Sticker",
          "price": 2.5,
          "total": 2.5,
          "weight": 0.25,
          "quantity": 1,
          "weight_unit": "lbs",
          "total_weight": 0.25,
          "harmonized_code": "",
          "country_of_origin": ""
        },
        {
          "id": "3ae53a2f-48b8-46bf-969c-7a910bf68ca1",
          "sku": "DSPT-XL",
          "name": "Dog Saver Promo T-shirt XL",
          "price": 19.95,
          "total": 39.9,
          "weight": 2,
          "quantity": 2,
          "weight_unit": "lbs",
          "total_weight": 4,
          "harmonized_code": "",
          "country_of_origin": ""
        }
      ],
      "notes": [],
      "store": {
        "id": "ef22f5b4-23ab-435d-b091-31a5f10a8c59",
        "logo": "2b8a4a59-0c07-4bbb-a004-4a53e760bd3d",
        "name": "Dog Savers Promo",
        "type": "csv",
        "address": {
          "city": "St. Louis",
          "name": "Shipping Department",
          "email": "shipping@email.com",
          "phone": "314-555-5555",
          "state": "MO",
          "company": "STL Dog Savers",
          "postal_code": "63139",
          "country_code": "US",
          "street_line_1": "1940 Hampton Avenue",
          "street_line_2": ""
        }
      },
      "total": 42.4,
      "number": "DS2500",
      "source": "Widget Me This",
      "status": "Ready to Ship",
      "charges": [],
      "payment": {
        "id": "42630d63-6177-4bb2-bd95-87da6b8e89cf",
        "name": "",
        "amount": 0,
        "details": {}
      },
      "archived": false,
      "subtotal": 42.4,
      "import_id": "28309eb7-c1c1-4380-8bb5-ece9035bca30",
      "created_at": "2026-04-23T14:19:01.846Z",
      "import_ids": [
        "6227dded-c1fd-4bba-aea0-1c13267c8b7e",
        "28309eb7-c1c1-4380-8bb5-ece9035bca30"
      ],
      "updated_at": "2026-04-23T14:46:42.661Z",
      "bill_address": {
        "id": "991bd6bb-d9f6-4f81-bb5d-467fa923927d",
        "city": "St. Louis",
        "name": "Sara Green",
        "email": "SaraRGreen@gustr.com",
        "phone": "814-340-8725",
        "state": "MO",
        "company": "Northern Reflections",
        "postal_code": "63101",
        "country_code": "US",
        "street_line_1": "1119 N Tucker Blvd"
      },
      "ship_address": {
        "id": "2c40dacd-6d07-47ae-8ff4-76128936f0e5",
        "city": "St. Louis",
        "name": "Sara Green",
        "email": "SaraRGreen@gustr.com",
        "phone": "814-340-8725",
        "state": "MO",
        "company": "Northern Reflections",
        "postal_code": "63101",
        "country_code": "US",
        "street_line_1": "1119 N Tucker Blvd"
      },
      "requested_shipping": "Economical"
    },
    "shipments": [
      {
        "id": "0adabbf7-0909-4fd0-afa8-257970ce6732",
        "status": "unprocessed",
        "carrier": "usps",
        "service": "usps_ground_advantage",
        "domestic": true,
        "packages": [
          {
            "id": "a41164e4-a743-49ad-ab34-fd6e5df6dad7",
            "value": 42.4,
            "width": 8,
            "height": 2,
            "length": 10,
            "weight": 1.25,
            "dim_unit": "in",
            "sequence": 0,
            "shipment_id": "0adabbf7-0909-4fd0-afa8-257970ce6732",
            "weight_unit": "lbs",
            "package_type": "parcel"
          }
        ],
        "insurance": {
          "cost": 0,
		  "amount_source": "items",
          "apply_insurance": false,
          "insurance_provider": "shipsurance"
        },
        "reference": "ab1b7cc8-acdb-57a5-9d9a-ffb01b6b02ba",
        "ship_date": "2026-04-23T14:36:45.930Z",
        "created_at": "2026-04-23T14:19:11.079Z",
        "to_address": {
          "id": "414883c2-d9ac-4709-abf7-e32f9343b0b8",
          "city": "St. Louis",
          "name": "Sara Green",
          "email": "SaraRGreen@gustr.com",
          "phone": "814-340-8725",
          "state": "MO",
          "company": "Northern Reflections",
          "postal_code": "63101",
          "residential": "using_address_validation",
          "country_code": "US",
          "street_line_1": "1119 N Tucker Blvd",
          "address_validation": {
            "valid": true,
            "residential": false,
            "standardized": {
              "city": "SAINT LOUIS",
              "name": "Sara Green",
              "state": "MO",
              "postal_code": "63101-1027",
              "country_code": "US",
              "street_line_1": "1119 N TUCKER BLVD",
              "street_line_2": ""
            },
            "original_address_hash": "2e1b1a45f30621d92711f2b00052784f71809c3c"
          }
        },
        "updated_at": "2026-04-23T14:36:45.930Z",
        "reference_1": "",
        "reference_2": "",
        "confirmation": "none",
        "rate_selection": "manual",
        "from_address_type": "origin_address",
        "origin_address_id": "7a67d35a-3959-42fd-8374-8766ad5672f1",
        "return_shipment_data": {},
        "return_shipment_type": "include_return_label"
      }
    ]
  },
  "event": "order_note_deleted",
  "timestamp": "2026-04-23T14:46:43.104Z"
}

Webhook Subscriptions

Contact Us

Before We Begin

Good to Know

Subscribe to Postsale Webhook Events

Create a Webhook Subscription

Procedure: Settings > Account Settings

More Than One Webhook

Manage Webhook Subscriptions

Procedure: Settings > Account Settings

View Delivery Logs

Edit the Webhook Subscription

Delete a Webhook Subscription

About Webhook Events

A Shipment is Processed

Sample POST

A Shipment is Voided

A Label's Tracking Status Has Changed

An Order's Status Has Changed

An Order is Imported

An Order is Reimported

An Order Note is Created

An Order Note is Updated

An Order Note is Deleted

Related Articles