Webhooks are the perfect solution to receive real-time information.

ShippyPro provides you with the possibility to receive labels, tracking updates and error messages for the orders almost instantly. ✨

Learn more about our APIs in our API Documentation.

Keep reading to discover how to connect Webhooks to your Server! πŸ”Ž

  • First of all, 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 you'll pick from the list right below.

You'll be able to choose from: Order Shipped, Order Error and Tracking Updates.

  • At this point, 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 you can decide not to include it.

Once included, decide if enable Retry option for 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.

πŸ“ŒNote: Webhooks works on returns too!

Here you can find a list of the status that can be displayed together with their meaning:

2Γ—Γ— Success

3Γ—Γ— Redirection

4Γ—Γ— Client Error

5Γ—Γ— Server Error

And you're done! 🎈

πŸ”Ž What's Next?

Did this answer your question?