Shipwell API

The Shipwell Developer Hub

Welcome to the Shipwell developer hub. You'll find comprehensive guides and documentation to help you start working with Shipwell API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

What are Webhooks?

How to use webhooks to plugin to real-time supply chain data

Shipwell uses webhooks to notify your applications any time an event happens for various supply chain milestones, updates, and predictive events. Set up webhooks for events that Shipwell doesn’t already notify you of, like when a shipment is in_transit, or a customer goes over credit.

A webhook endpoint is like a function that Shipwell calls when certain things happen in your supply chain. Shipwell creates an Event object for each occurrence in various objects that are worth notifying you about, like a shipment being delayed, or a payout to a carrier. Each event contains data explaining what happened.

When you create a webhook handler, it listens for specific events, then takes action whenever those events get sent to the endpoint. Technically, a webhook handler is just a script in a server-side language, like Python, C#, or Node, that handles any events you specify in the Dashboard. We add events weekly to the platform so if you don't see an event you would like, send a request to [email protected] and we can get it added.

Webhooks can also be used to provide state and API responses to services or systems that use Shipwell data for things like replication, analytics, alerting, or customer success.

When to use webhooks

Webhooks are necessary for behind-the-scenes transactions like the Shipwell Events API and many alerting and long-running tasks in Shipwell. For many supply chain functions (like tracking an order or shipment) Shipwell needs to notify your integration about changes to the status of the object so that you can act on them.

Some Shipwell requests (e.g., tracking, tendering, or payments) generate results that Shipwell reports synchronously to your code. These integrations don’t require your verification, but the events allow you to share information with other systems. You can also use webhooks in these synchronous integrations to automate business tasks:

  • Track an order or a shipment
  • Email a customer when a shipment is delivered
  • Create a notification to a carrier that they have been paid
  • Make adjustments to an invoice when it’s created (but before it’s been paid)
  • Create an alert when your routing guide is about to fail

Updated about a month ago

What are Webhooks?

How to use webhooks to plugin to real-time supply chain data

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.