Skip to content
MothershipDevelopers

Webhook eventsDocuments

Bill of lading updated

Sent when a new version of a bill of lading is attached.

EVENTbillOfLading.updated
POST to your endpointSigned with HMAC-SHA256Retried for up to 4 days
RequestPOSThttps://your-server.example.com/webhooks/mothership
Content-Type:application/json
X-Mothership-Signature:7999b2099ae46383da26ed3fed99d15f3509df785e2b0051f6034562c2f727d9
X-Mothership-Delivery-Id:3f6c1a9e-8b2d-4c7a-9e15-2d8b7f4a6c01
{
: "billOfLading.updated",
: {
: "MS123456",
: "billOfLading",
: "https://files.mothership.com/MS123456/billOfLading.pdf",
: "2026-10-15T15:04:05.000Z",
: "2026-10-08T15:04:01.000Z"
},
: "2026-10-08T15:04:05.000Z",
: 1,
: 16
}

Hover a key to see what it means. Click it to jump to the field.

Sent each time a new bill of lading replaces the shipment's last one, such as after a correction. Each version has its own url, so download the new one and keep it as the current version.

Unlike billOfLading.created, this event has no createdAt.

Subscribing

Add billOfLading.updated to a configuration's subscribedEvents with Create a webhook configuration or in the dashboard.

Event data

data · 5 keys
  • shipmentIdstring

    The shipment's reference number, such as MS123456. Pass it to Get shipment details.

  • typestring

    The kind of document.

    billOfLading
  • urlstring

    Where to download the document. Download it when the event arrives. To fetch it later, call List shipment documents for a current URL.

  • expiresAtstringDeprecated

    An ISO 8601 string a year after Mothership built the event. It still goes out on every document event, but it doesn't say when url stops working.

  • updatedAtstring

    When Mothership built the event for the new version, as an ISO 8601 string in UTC.

Envelope

Same on every event
  • eventTypestring

    The event. Always billOfLading.updated here. Route on it, and answer 2xx to types you don't handle.

  • sentAtstring

    When Mothership queued the event to send, as an ISO 8601 string in UTC. Every retry and resend carries the same value, so it does not say when this attempt went out.

  • deliveryAttemptinteger

    Which send of this event this is, starting at 1. Resends from the dashboard count too.

  • pendingRetriesinteger

    How many automatic attempts are left if this one fails. 0 on the last one.

Related

billOfLading.createdSent when a bill of lading is first attached to a shipment.Receiving webhooksVerify the signature, answer within 30 seconds, and handle retries and duplicates.