Webhook notifications

Overview

  • Webhooks (callbacks) are scheduled or event driven executions of code to send data from one application to another.
  • An example of a webhook is a push notification from an email server to your phone.
  • Starshipit can send webhook requests when we receive tracking updates from your courier for your orders. You can specify a notification endpoint URL where Starshipit will send these requests.

How it works

You can use the notification endpoint URL to receive our webhook data and trigger a certain event in your own application.
E.g. Send an order update email to your customer or update the order status in your database when 'OutForDelivery' tracking status is received.

The notification endpoint URL needs to be built to accept the POST request that returns HTTP 200 OK response and the URL can be set in Starshipit > Settings > Tracking & notifications.

Webhook JSON Data Definitions

Name Data Type Description
order_number
string The identifier of the order pulled from source e-Commerce platform
carrier_name
string Name of the courier used for shipment delivery
carrier_service
string Courier product service used for shipment delivery
shipment_date
datetime The local date when the label was generated for the shipment
tracking_number
string Courier tracking number
tracking_status
string Last tracking status from the courier
last_updated_date
datetime Last tracking updated date from the courier

Tracking Statuses

  • Printed
  • Dispatched
  • InTransit
  • OutForDelivery
  • Delivered
  • PickupInStore
  • AttemptedDelivery
  • Exception
  • AwaitingCollection
  • Cancelled

Webhook POST Data Example

{
  order_number:5567476,
  carrier_name:Australia Post,
  carrier_service:7B05,
  shipment_date:2018-08-09T02:55:37.1446912Z,
  tracking_number:QQQ001737901000931501,
  tracking_status:Dispatched,
  last_updated_date:2018-08-09T02:56:07.3453198Z
}

Want to deliver great shipping experiences?

Start a 30-day free trial or book a demo with one of our shipping experts

Was this article helpful?
0 out of 1 found this helpful

Comments

0 comments

Article is closed for comments.