Ongoing Warehouse logo

Ongoing Warehouse Developer

Webhooks

Table of contents

Introduction

A webhook is a way for the Ongoing WMS to send an HTTP request to your server when some even occurs in the Ongoing WMS. Using webhooks means that you don't have to poll the Ongoing WMS for changes, which means that webhooks are more efficient than a traditional API integration.

As an example, you can set up a webhook which makes a call to https://yourserver.com/api/OngoingOrderPicked whenever an order is picked in the Ongoing WMS. When an order is picked, the following happens:

  1. Order 12345 is picked in Ongoing WMS.
  2. Ongoing WMS triggers the webhook.
  3. An HTTP request is made to https://yourserver.com/api/OngoingOrderPicked, with a JSON payload indicating that order 12345 was picked.
  4. Your server can process this request and do what you like, such as sending an email to the end customer. If the webhook payload does not contain all the information that you want, make a request back to one of our APIs to fetch more information.

Creating a webhook

Go to Settings ⇒ Webhooks and click on Create new webhook. Fill in the URL and an email. Tick Enabled if you want to enable the webhook.

Testing a webhook

If you wish to trigger a webhook manually, for testing purposes, go to Settings ⇒ Webhooks and find the webhook in the list. Click on Test.