Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Navigate back to the Shipments screen in Acumatica.

  2. The fields in the ShipHawk Shipment Details section should populate the following information accordingly:

    1. Sent to ShipHawk checkbox is selected.

    2. Last Sync Date is no longer blank.

  3. Click the ShipHawk Actions button on the form toolbar. Select the Get Shipment Confirmation action from the drop-down.

  4. Click on the ShipHawk Info tab near the grid at the bottom of the Shipments page. The data from the ShipHawk Order details screen should be displayed in the grid below the tab.

  5. Click on the Packages tab to the right of the ShipHawk Info tab. The shipment details you confirmed in ShipHawk, along with the order tracking number, should be displayed in the grid below the tab.

...

Webhooks for Shipment Data 

For performance,  webhooks are used to get the shipment information rather than API calls.

(Note that if an Acumatica user working on a Shipment record selects Actions > Get Shipment Confirmation, an API call is still used on a one-time basis to get the information immediately.)

To configure the webhook, you first create the webhook URL in Acumatica and then set up the webhook in ShipHawk.

Creating Webhook URL in Acumatica

To create a webhook URL in Acumatica:

  1. On the Acumatica user interface, open the Webhooks page.

  2. In the Webhook Name field, enter a name for the ShipHawk webhook, such as “SHWebook”.

  3. Make sure the Active checkbox is selected.

  4. In the Implementation Class field, enter the implementation class, such as “ShipHawk SHWKWebhookHander”.

  5. Upon saving, a URL is generated and displayed in the URL field:

    Image Added


  6. Copy this URL so that you can use it to set up the webhook in ShipHawk.

Setting Up Webhook in ShipHawk

To set up the webhook in ShipHawk:

  1. On the ShipHawk user interface, select Settings (gear icon) > Settings > Webhooks to view the Webhooks Management page.

  2. Select Actions > Create New Webhook:

    Image Added


  3. In the Create a new webhook window, in the Callback URL field at the top, paste the URL you copied from Acumatica.
    NOTE: Make sure Use Basic Authentication is not selected.

    Graphical user interface, text, application

Description automatically generatedImage Added


  4. Under Events, select the shipment.create_from_order event checkbox.

  5. Click Create to save the new webhook setting.

Now, when a shipment is completed, the webhook will be triggered and the response will be sent to Acumatica.

On the Acumatica user interface, on the Webhooks page for the ShipHawk webhook, you can see the activity in the REQUEST HISTORY tab. You can click on a POST request to view the Request Details window.

Additional ShipHawk Screens

...