Server Extension

A server extension makes it possible for 3PL license holders to add extra functionalities to Webship Online, such as adding information to an order that first needs to be retrieved from another server or first validated by external parameters. The difference between webhooks and a server extension is that Webship Online will wait for an answer from the addressed server before proceeding.

Via Admin > Server Extension, the server extension can be set up and server extension hooks can be created and managed.

Server Extension Settings

Before using the server extension, the following settings must be filled in:

  • Enabled: Whether the server extension is enabled or not
  • URL: The URL at which Webship Online will send HTTP requests
  • Secret: A unique key used to secure communication between Webship Online and the server extension

Server Extension Hooks

A server extension hook consists of a trigger and several optional filters.

Triggers

For each server extension hook, a trigger must be chosen. An event at which Webship Online will send an HTTP request to a chosen URL. Some important triggers are for example:

  • When shipments are registered on an order
  • When an order is modified

Filters

Filters are optional and can be used to determine whether Webship Online should contact the server extension. Since HTTP traffic between Webship Online and the server extension may take some time, it's best to avoid this traffic as much as possible by for example only contacting the server extension for orders of certain shops.

When is the server extension contacted?

Server extension hooks are always executed before the trigger of the hook is stored in the database. This means that when a hook is executed at the time an order is being modified, the server extension (if necessary) can still make adjustments before the order is saved to our database.

Examples

A server extension thus allows adding an endless series of functionalities to Webship Online. Some good examples are:

  • Setting up a preferred carrier based on parameters in external software
  • Custom shipping labels that can be added to orders and then printed out by Webship Online

Using Server Extensions

Since setting up and using a server extension is custom-made software, it's best to contact the developers of Webship Online to discuss all technical aspects.