Webhooks Management

Webhooks are user-defined HTTP callbacks.

ShipHawk supports a wide variety of event triggers, including:

• A shipment is booked

• A shipment tracking status has changed

• A note is added to a shipment

• A shipment address has changed

When these events occur, ShipHawk makes an HTTP request to the URI configured for the webhook.

Users can configure them to cause events on one site to invoke behavior on another.

To create a new webhook, from Actions, choose Create New Webhook:

...

Create a new webhook

On the Create a new webhook pop-up screen, you specify the callback URL and if you want to use basic authentication.

Callback URL – Enter the callback URL

Use Basic Authentication – Select to use basic authentication. In basic HTTP authentication, the URL includes username:password@ before the hostname in your webhook URL, and the those credentials are then sent in the HTTP header: https://username:password@www.example.com.

Events

• shipment.status_update

• shipment.address_update

• shipment.notes_update

• shipment.timing_update

• shipment.tracking_update

• shipment.documents_update

• shipment.create_from_order

• shipment.create

• proposed_shipment.create

• order.document_create

• return_shipment.status_update

To save the webhook, click Create.