NRGship FM for UPS Webhooks using Otto

OttoFMS from Proof+Geist can be used to receive incoming messages for UPS Track Alert notifications in NRGship FM for UPS. We've already included the OttoReceiver table, layout and scripts to process the messages.

UPS Track Alert in NRGship is a premium service offering which reduces server overhead by providing tracking and delivery data directly in NRGship as events occur without the need for automated or user-invoked tracking.

If your FileMaker Server is not exposed to the outside world or you are not comfortable setting up Otto, you can still access Track Alert functionality by simply enabling Track Alert without entering an endpoint value. NRG Software will act as an intermediary and will accept webhook requests on your behalf. Check out this article for more information.

As part of this setup, we are making the assumption that the NRGship files are hosted on your FileMaker Server, Otto is installed, the necessary APIs are enabled and your server allows access from outside your firewall.

First, open the NRGship UPS Pro Data file with the default user and password of dev/dev and enable the webhook user account. From the Scripts Menu, select the Enable Webhook Account script. Enter a new password and confirm.

Now, open OttoFMS on your FileMaker Server and select the Webhooks button. Register a new webhook for the NRGship UPS Pro Data file using the webhook account and password you created above. Set the channel value to be trackalertwithphoto and check the box to include the API key in the URL. Copy the Webhook URL value and finish registering the webhook.

Finally, open NRGship Pro for UPS using the FileMaker Pro application. Select Preferences->Integration. Paste the webhook URL that was copied into the Endpoint field. Paste the apiKey portion into the API Key field.

The most recent Track Alert data will show on the Results tab including the button to view the delivery photo when present. Fields for Pickup Date, Scheduled Delivery, Delivered and Exception will be updated as well. The user post-shipment script in NRGship will also be invoked if enabled in NRGship preferences.

Note: Only residential deliveries where the package was driver released are eligible for delivery photo. This means that if the package was delivered to a commercial building, the package was handed to a person, or if a signature was collected, no delivery photo will be available.