Webhooks are the perfect solution to receive real-time information.
ShippyPro provides you with the possibility to receive labels, tracking updates and error messages of the orders almost instantly. ✨
Learn more about our APIs in our API Documentation.
Keep reading to discover how to connect Webhooks to your Server! 🔎
📌To connect a new Webhook it's required to have a subscription to a customized Annual Plan, please get in touch with our Commercial Department at [email protected] for more information.
Kindly note that you can connect up to three Webhooks.
First, go to Integrations and API > API and click on Add Webhook.
Then attach the URL to the server where you'd like to receive all the information for the specific Event or Events from the list right below.
You'll be able to choose from: Order Shipped, Order Error and Tracking Updates.
Next, enter your Username and Password for your Webhook Server-side authentication.
📌 Note: auth it's not a mandatory step, if your server doesn't have it then you can decide not to include it.
Once included, decide if you want to enable a Retry option in case Webhooks fails.
You can also set the maximum Count of Retry up to 10 times.
When your Webhook will be connected, you can either Edit, Delete or Test it.
By clicking on Test you'll be able to display all the information transmitted:
While clicking on View Webhooks Logs you'll find a list of all your Logs, to Filter them for Endpoint, Event, Result or Retry you'll only have to click on the specific filters.
Here the info you'll be able to display from this section:
Date
Date End
Order ID
Transaction ID
Carrier
Endpoint
Event
Result
Retry
Time Spent
Request
Response
📌 Note: Webhooks works on returns too!
📌 Webhook files are in Json format.
Here you can find a list of the status that can be displayed together with their meaning:
2×× Success
200 OK
201 Created
202 Accepted
203 Non-authoritative Information
204 No Content
205 Reset Content
206 Partial Content
207 Multi-Status
208 Already Reported
226 IM Used
3×× Redirection
300 Multiple Choices
301 Moved Permanently
302 Found
303 See Other
304 Not Modified
305 Use Proxy
307 Temporary Redirect
308 Permanent Redirect
4×× Client Error
400 Bad Request
401 Unauthorized
402 Payment Required
403 Forbidden
404 Not Found
405 Method Not Allowed
406 Not Acceptable
407 Proxy Authentication Required
408 Request Timeout
409 Conflict
410 Gone
411 Length Required
412 Precondition Failed
413 Payload Too Large
414 Request-URI Too Long
415 Unsupported Media Type
416 Requested Range Not Satisfiable
417 Expectation Failed
418 I'm a teapot
421 Misdirected Request
422 Unprocessable Entity
423 Locked
424 Failed Dependency
426 Upgrade Required
428 Precondition Required
429 Too Many Requests
431 Request Header Fields Too Large
444 Connection Closed Without Response
451 Unavailable For Legal Reasons
499 Client Closed Request
5×× Server Error
500 Internal Server Error
501 Not Implemented
502 Bad Gateway
503 Service Unavailable
504 Gateway Timeout
505 HTTP Version Not Supported
506 Variant Also Negotiates
507 Insufficient Storage
508 Loop Detected
510 Not Extended
511 Network Authentication Required
599 Network Connect Timeout Error
And you're done! 🎈