Webhook Creation and Function Extra Documentation

Getting Started
1

Hi,

As general context about what I’m trying to do, I want to receive an update whenever goods are sent out and whenever goods are received by Shiphero. Hence I found the PO Update webhook and the Shipment Update webhook. (please send me another way if there is a better approach.)

What I am missing from the documentation is:

  • Is there a retry mechanism in place if the webhook does not receive any response or no status 200 response? Is there a maximum retry counter in place and is there a notification setting that would notify me if the maximum of retries has been reached?
  • What are the triggers for the webhooks? For example, It seems that after receiving the PO and updating the “expected on” date, the webhook is no longer triggered. Is there a comprehensive list of triggers somewhere? or is it as easy as only changes to any of the fields in the body of the webhook?

Thanks in advance!
Erik

2

Hi @erik

Welcome to the ShipHero community!

You are spot on in choosing the correct webhooks for what you are trying to achieve.

There is no retry mechanism for webhooks. If you do not get a webhook, please let us know, providing an example, and we’ll investigate.

The PO should trigger when created, closed, or any line_items are updated, like adding a line_item or partially receiving quantity.

The Shipment webhook will trigger whenever an order gets fulfilled from shipping.shiphero.com as single order or using bulk ship, or when it gets fulfilled from the API.

Have a nice day!

1 Like