> For the complete documentation index, see [llms.txt](https://docs.partssource.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.partssource.com/webhooks-customer/event-reference.md). # Event Reference {% hint style="info" %} This reference is generated from the webhook OpenAPI specification. Event availability and integration guidance live in the Event Catalog; field-by-field presence detail lives in the Payload Reference. {% endhint %} ### Order lifecycle {% openapi-webhook spec="customer-webhooks" name="customer.order.line.created" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} {% openapi-webhook spec="customer-webhooks" name="customer.order.line.backorder.created" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} {% openapi-webhook spec="customer-webhooks" name="customer.order.line.backorder.updated" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} {% openapi-webhook spec="customer-webhooks" name="customer.order.line.cancelled" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} ### Approvals {% openapi-webhook spec="customer-webhooks" name="customer.order.line.approval.requested" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} {% openapi-webhook spec="customer-webhooks" name="customer.order.line.approval.approved" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} {% openapi-webhook spec="customer-webhooks" name="customer.order.line.approval.rejected" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} {% openapi-webhook spec="customer-webhooks" name="customer.order.line.approval.completed" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} ### Shipments {% openapi-webhook spec="customer-webhooks" name="customer.shipment.shipped" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} {% openapi-webhook spec="customer-webhooks" name="customer.shipment.tracking.assigned" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} {% openapi-webhook spec="customer-webhooks" name="customer.shipment.estimated\_ship\_date.created" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} {% openapi-webhook spec="customer-webhooks" name="customer.shipment.estimated\_ship\_date.updated" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} ### Deprecated events {% hint style="warning" %} The two events below are deprecated — migrate to `customer.shipment.estimated_ship_date.*`. See the deprecation policy in the Overview. {% endhint %} {% openapi-webhook spec="customer-webhooks" name="order.line.estimated\_ship\_date.created" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} {% openapi-webhook spec="customer-webhooks" name="order.line.estimated\_ship\_date.updated" method="post" %} [customer-webhooks](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/61ebb0ed7e79416e00082d47683f924fe012a5052465ec65633c13381c044df9.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=dce48141f43c0191a2ad043a6888781c%2F20260928%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20260928T005724Z\&X-Amz-Expires=172800\&X-Amz-Signature=8b641711a50e147e5dca1055fe8f1b98ddda4541b2764d30a4cf09ec767b06a6\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject) {% endopenapi-webhook %} ### Shared objects ## The WebhookEnvelope object ```json {"openapi":"3.1.0","info":{"title":"Customer Webhooks","version":"v1"},"components":{"schemas":{"WebhookEnvelope":{"type":"object","title":"Webhook envelope","description":"Standard envelope wrapping every webhook delivery. Event-specific detail lives in `payload`.","required":["event_type","company_id","order_id","line_item_type","occurred_at","payload"],"properties":{"event_type":{"type":"string","description":"The event type identifier"},"company_id":{"type":"integer","format":"int64","description":"Company ID for multi-tenant isolation"},"order_id":{"type":"integer","format":"int64","description":"Unique identifier for the order"},"line_item_id":{"type":"integer","format":"int64","description":"Line item identifier. Present on line-level events, omitted on order-level events"},"line_item_type":{"$ref":"#/components/schemas/LineItemType"},"occurred_at":{"type":"string","format":"date-time","description":"Timestamp when the event occurred"},"payload":{"type":"object","description":"The event-specific payload"},"correlation_id":{"type":"string","description":"Correlation ID for tracing across services. Omitted when there is no value"},"source":{"type":"string","description":"Name of the publishing service. Omitted when there is no value"},"metadata":{"type":"object","description":"Additional key/value metadata. Omitted when there is no value","additionalProperties":true}}},"LineItemType":{"type":"string","description":"Line item classification: `part` (physical part), `depot_flat_rate` (depot repair at a flat rate), `depot_quoted` (depot repair, quoted), `service` (on-site or remote service)","enum":["part","depot_flat_rate","depot_quoted","service"]}}}} ``` ## The ShipAddress object ```json {"openapi":"3.1.0","info":{"title":"Customer Webhooks","version":"v1"},"components":{"schemas":{"ShipAddress":{"type":"object","title":"ShipAddress","description":"A destination address. Nested inside `Order`. Omitted when there is no value.","properties":{"ship_address_id":{"type":"integer","format":"int64","description":"Address identifier. Omitted when there is no value"},"attention_to":{"type":"string","description":"Attention line. Omitted when there is no value"},"edi_sender_code":{"type":"string","description":"EDI sender code. Omitted when there is no value"},"address_1":{"type":"string","description":"Address line 1. Omitted when there is no value"},"address_2":{"type":"string","description":"Address line 2. Omitted when there is no value"},"address_3":{"type":"string","description":"Address line 3. Omitted when there is no value"},"city":{"type":"string","description":"City. Omitted when there is no value"},"state":{"type":"string","description":"State or province. Omitted when there is no value"},"zip_code":{"type":"string","description":"Postal code. Omitted when there is no value"},"country":{"type":"string","description":"Country. Omitted when there is no value"}}}}}} ``` ## The Note object ```json {"openapi":"3.1.0","info":{"title":"Customer Webhooks","version":"v1"},"components":{"schemas":{"Note":{"type":"object","title":"Note","description":"A note attached to a line item. Nested inside `Order`.","required":["note_id","note","added_at"],"properties":{"note_id":{"type":"integer","format":"int64","description":"Note identifier"},"note":{"type":"string","description":"Note text"},"added_at":{"type":"string","format":"date-time","description":"When the note was added"},"added_by":{"type":"string","description":"Who added the note — use `added_by_id`. Not currently sent"},"added_by_id":{"type":"integer","format":"int64","description":"Author identifier. Omitted when there is no value"}}}}}} ``` ## The Fee object ```json {"openapi":"3.1.0","info":{"title":"Customer Webhooks","version":"v1"},"components":{"schemas":{"Fee":{"type":"object","title":"Fee","description":"An additional charge. Nested inside `Order`. The parent `fees` field is not currently sent.","required":["name","value"],"properties":{"name":{"type":"string","description":"Fee name"},"value":{"type":"number","description":"Fee amount"}}}}}} ``` ## The FieldValue object ```json {"openapi":"3.1.0","info":{"title":"Customer Webhooks","version":"v1"},"components":{"schemas":{"FieldValue":{"type":"object","title":"FieldValue","description":"A custom field value. Nested inside `Order`. The parent `field_values` field is not currently sent.","properties":{"field_uid":{"type":"string","description":"Field unique identifier. Omitted when there is no value"},"name":{"type":"string","description":"Field name. Omitted when there is no value"},"value":{"type":"string","description":"Field value. Omitted when there is no value"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.partssource.com/webhooks-customer/event-reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.