{"templateId":"markdown","versions":[{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/guides/webhooks-schemas","default":false,"active":false,"folderId":"58c9a61d"},{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/docs/guides/webhooks-schemas","default":true,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/guides/webhooks-schemas","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Webhook Payload Schemas","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"webhook-payload-schemas","__idx":0},"children":["Webhook Payload Schemas"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example payloads for each type of webhook are provided below. You can expect to receive a message with the same structure as these examples whenever you subscribe to the corresponding event. You'll notice that each payload includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resource_type"]}," and a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resource_url"]},". Some payloads will contain additional information as well."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"webhook-event-payloads","__idx":1},"children":["Webhook Event Payloads"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"batch-processed-batch_processed_v2","__idx":2},"children":["Batch Processed (BATCH_PROCESSED_V2)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"resource_url\": \"https://api.shipstation.com/v2/batches/se-1234567890\",\n  \"resource_type\": \"BATCH_PROCESSED_V2\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"track-event-track_event_v2","__idx":3},"children":["Track Event (TRACK_EVENT_V2)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"resource_url\": \"https://api.shipstation.com/v2/labels/se-1234567890/track\",\n    \"resource_type\": \"TRACK_EVENT_V2\",\n    \"data\": {\n        \"tracking_number\": \"1Z0000000000000000\",\n        \"tracking_url\": \"http://wwwapps.ups.com/WebTracking/processRequest?HTMLVersion=5.0&Requester=NES&AgreeToTermsAndConditions=yes&loc=en_US&tracknum=1Z0000000000000000\",\n        \"status_code\": \"NY\",\n        \"status_detail_code\": null,\n        \"status_detail_description\": null,\n        \"carrier_code\": \"ups\",\n        \"carrier_id\": 3,\n        \"carrier_detail_code\": \"MP\",\n        \"status_description\": \"Not Yet In System\",\n        \"carrier_status_code\": \"M\",\n        \"carrier_status_description\": \"Shipper created a label, UPS has not received the package yet.\",\n        \"ship_date\": null,\n        \"estimated_delivery_date\": \"2026-04-30T00:00:00\",\n        \"actual_delivery_date\": null,\n        \"exception_description\": null,\n        \"events\": [\n            {\n                \"occurred_at\": \"2026-04-29T22:59:36Z\",\n                \"carrier_occurred_at\": \"2026-04-29T15:59:36\",\n                \"description\": \"Shipper created a label, UPS has not received the package yet.\",\n                \"city_locality\": \"\",\n                \"state_province\": \"\",\n                \"postal_code\": \"\",\n                \"country_code\": \"US\",\n                \"company_name\": null,\n                \"signer\": \"\",\n                \"event_code\": \"M\",\n                \"carrier_detail_code\": \"MP\",\n                \"status_code\": \"NY\",\n                \"status_description\": \"Not Yet In System\",\n                \"carrier_status_code\": \"M\",\n                \"carrier_status_description\": \"Shipper created a label, UPS has not received the package yet.\",\n                \"status_detail_code\": null,\n                \"status_detail_description\": null,\n                \"proof_of_delivery_url\": null,\n                \"latitude\": null,\n                \"longitude\": null\n            }\n        ]\n    }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"shipment-created-shipment_created_v2","__idx":4},"children":["Shipment Created (SHIPMENT_CREATED_V2)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"resource_url\": \"https://api.shipstation.com/v2/shipments?import_batch_id=14b27e3b-4346-4ea2-ae7a-0fc01eb365a0\",\n  \"resource_type\": \"SHIPMENT_CREATED_V2\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"label-created-label_created_v2","__idx":5},"children":["Label Created (LABEL_CREATED_V2)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"resource_url\": \"https://api.shipstation.com/v2/labels?batch_id=se-1234567890\",\n  \"resource_type\": \"LABEL_CREATED_V2\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"fulfillment-shipped-fulfillment_shipped_v2","__idx":6},"children":["Fulfillment Shipped (FULFILLMENT_SHIPPED_V2)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"resource_url\": \"https://api.shipstation.com/v2/fulfillments?fulfillment_id=se-1234567890&shipment_id=se-0987654321\",\n  \"resource_type\": \"FULFILLMENT_SHIPPED_V2\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"fulfillment-rejected-fulfillment_rejected_v2","__idx":7},"children":["Fulfillment Rejected (FULFILLMENT_REJECTED_V2)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"resource_url\": \"https://api.shipstation.com/v2/shipments/se-1234567890\",\n    \"resource_type\": \"FULFILLMENT_REJECTED_V2\"\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Webhook Payload Schemas","id":"webhook-payload-schemas","depth":1},{"value":"Webhook Event Payloads","id":"webhook-event-payloads","depth":2},{"value":"Batch Processed (BATCH_PROCESSED_V2)","id":"batch-processed-batch_processed_v2","depth":3},{"value":"Track Event (TRACK_EVENT_V2)","id":"track-event-track_event_v2","depth":3},{"value":"Shipment Created (SHIPMENT_CREATED_V2)","id":"shipment-created-shipment_created_v2","depth":3},{"value":"Label Created (LABEL_CREATED_V2)","id":"label-created-label_created_v2","depth":3},{"value":"Fulfillment Shipped (FULFILLMENT_SHIPPED_V2)","id":"fulfillment-shipped-fulfillment_shipped_v2","depth":3},{"value":"Fulfillment Rejected (FULFILLMENT_REJECTED_V2)","id":"fulfillment-rejected-fulfillment_rejected_v2","depth":3}],"frontmatter":{"seo":{"title":"Webhook Payload Schemas"}},"lastModified":"2026-09-18T22:56:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/docs/guides/webhooks-schemas","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}