Webhooks are HTTP-based notifications that leverage Extensiv's REST API to retrieve transaction and inventory data based on "events" that take place in the 3PL Warehouse Management. Once webhooks are configured in 3PL Warehouse Manager, you or your developer resource can parse and interpret the data as needed for your operations.

This article reviews how to configure webhooks.

Configuration steps

Each webhook event falls into seven event types (Order, Receipt, Adjustment, Assembly, Order Item, Item, or Inventory Summary). Additionally, certain events can include its resource, which contains details about the transaction that spawned the event. You can find the full list of events and resources in the tables below.

1. To get started, navigate to Customers > Event Notifications in 3PL Warehouse Manager. 
2. In the left panel, select the Webhook Scope that best fits your needs. You can select a specific customer or set up a webhook for "Any Customer" if you want to receive events across all of your customers.

3. To create a new webhook, click New Webhook above the grid.
4. Enter a Description that describes what the webhook is used for—this value is primarily used to help you organize webhooks in the grid, then enter the appropriate Destination URL (must begin with https://)
5. Select an Event Type from the drop-down list, then select the appropriate event(s) and resource(s) to include in your webhook. You can find detailed descriptions for each event and resource in the tables below.
   

   Including resources in your payload allows you to retrieve the full object attached with the event notification, rather than just the relevant transaction ID. For example, for an "order create" event, the webhook not only communicates that an order was created, but also includes all the order details. Note that including these details could significantly increase your webhooks data usage.

    

6. Click Save to create the webhook.

Once an event is configured with your endpoint, the event triggers the WMS to send a message to the specified destination URL. You can view webhook utilization in the Support Portal on the Account page:

Events and resources

There are seven different event types currently available for webhooks: Order, Receipt, Adjustment, Assembly, Order Item, Item, and Inventory Summary. The events and resources for each event type are detailed below, as well as the API documentation links (i.e., the recommended APIs to be used to retrieve parsed or all details of each event).

Order

The events associated with orders are as follows:

The resources available to include in order events are as follows:

Receipt

The events associated with receipts are as follows:

The resources available to include in receipt events are as follows:

Adjustment

The events associated with adjustments are as follows:

The resources available to include in adjustment events are as follows:

Assembly

The events associated with assembly transactions are as follows:

The resources available to include in assembly events are as follows:

Order item

The events associated with order items are as follows:

The resources available to include in order item events are as follows:

Item

The events associated with items are as follows:

The resources available to include in item events are as follows:

Inventory summary

The events associated with inventory summaries are as follows:

The following resources for inventory summary events are automatically included:

*Delete events should not happen under normal circumstances. If you find that it does, please contact Technical Support.