Documentation

Setup how NxtPort can send you push notifications

Notification management

Introduction

For most use cases, NxtPort uses a notification system that allows you to be alerted on your configured webbook URL's whenever your supply chain partners make changes that generate an update for you. We support the HTTP rest protocol.

Certified Pick up notifications

Certified Pick up uses our improved notifications 2.0 functionality which is slightly different to setup than the legacy system. Follow the steps below to ensure that the notifications are sent to your notification channels. 

Create a Notification Channel

The first step to create notification channel(s) is to open the NxtPort console. 

Next, go to My Organization on the left side menu and click on "Notification channels". Please note that there are two types of Notification channels. One for Certified Pick up and one for other API's such as Bulkchain. 

Click on the "Notification Channels 2.0

Click on the "Add Notification Channel" button.

Channel type
NxtPort currently only supports the HTTP post protocol. For more information on this topic, please contact our support team

HTTP Method
Select the corresponding method we need to use when calling your endpoint. We use a POST by default

Authorization
When you activate the slider, you can add an Authorization Header Type and Header Credentials, allowing you to send specific information such as API keys. We currently don't support other authorization options.

Name 
This name will be used in the next step to identify the channel when linking the use case. 

Address
The endpoint which we will send a request to. We advise the usage of https calls to increase security

Select a notification channel

Once you have created your notification channel(s), you need to attribute them to the API's. Here as well, there is a difference between the Certified Pick up notification setup and those of other API's.

Select a notification channel for Certified Pick up

Go to Data User and select the Certified Pick up subscription. Click on the Live button. You will notice a warning message explaining that you the subscription is linked to an external service provider (C-point).

Click on the Notifications tab on the right side of the screen.

Click on the "Add notification" button. 

In this screen, select the previously created Channel and give an additional name. As you might be using the same channel for several use cases, this will allow you to have a better overview. 

When you save, you will have a new line in the Notification overview. As soon as the channel will receive notifications, you will be able to see the usage. 

 

Bulkchain

Bulkchain also uses the Notification system to send updates about changes on orders, visits, goods and stakeholders. To setup your webhook, go to the NxtPort console: 

Configure your notification channels

Login with your credentials and go to "My Organization" and select "Notification Channels". 

 

Click on the "Add notification channel" button

 

Default
Select this value to be default available for all Use Cases (other then Certified Pick Up). This setting needs to be selected for Bulkchain to function.

Enabled
Select the checkbox to enable your channel

Channel type

  • Wehbook (Preferred) 
    Configure an HTTP endpoint to which all your notifications will be sent. Enter the URL in the Address bar. We will send the notifications with a POST method.
    Remark 
    In case you would have an API key or require API user credentials, you need to enter them as Query parameters in the URL. So, for instance: https://api.yourcompany.com/nxtport/bulkchain/notifications?APIkey=12345667987&user=username&password=password.

  • Email
    Configure an e-mail address for receiving notifications
    Remark
    This is only intended for test purposes. Larger files may not be sent to your email channels, so this is not allowed to be used for production environments.

  • FTP/SFTP
    These methods are currently not configured for any of the existing API's. Please contact our support team in case you are interested for these custom solutions. 

Select a notification channel 

Other API's currently don't allow you to select a specific notification channel. Each of the notifications that is generated within the API/Use case, will automatically be sent to each of your active and default notification channels. To filter the information that needs to be sent to one or another channel, we advise you to use the "Asset" name in the notification content itself. 

All notifications for Bulkchain are sent to the Notification channels that have the checkbox of "Enabled" and "Default" activated.

 

Register your company