Setting up notification channels
Introduction
For most use cases, NxtPort uses a notification system that allows you to be alerted on your configured webhook URL's whenever your supply chain partners make changes that generate an update for you.
We support the HTTPS protocol.
Certified Pick up (CPu) notifications
CPu 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 CPu and one for other API's such as Bulkchain.
Console Company Overview
Click on the "Notification Channels 2.0”
Console Notifications 2.0
Click on the "Add Notification Channel" button and enter your channel details
Console Add Notification
Field Name | Info |
|---|---|
Channel Type | NxtPort only supports HTTPS Webhook for now |
HTTP Method | NxtPort only supports POST for now |
Channel Name | The name of the channel to be able to distinguish the channel from other channels |
Webhook URL | The address to where the POST request must be sent |
Headers | Optional headers will be added to the POST request when sending the notification. It is possible to add an ‘Authorization’ header when the Authentication Type is set to none |
Authentication Type | See below |
Authentication Type options
It is possible to let the NxtPort Notification Service fetch the access token itself, instead of using a static bearer token. This can be done by changing the Authentication Type to OAuth2 Client Credentials or OAuth2 Password Flow as seen below.
Client Credentials Flow
Client Credentials flow
Password Flow
Password flow
Field Name | Info |
|---|---|
Token Endpoint | The address where the token should be fetched from (e.g. |
Client Id | The client id that should be used |
Client Secret | The client secret that should be used |
Client Scopes | Optional scopes that should be sent with the request, can contain multiple scopes separated by whitespace |
Grant Type | Grant Type that should be used, automatically filed in based on the authentication type |
Authentication Headers | Optional headers that should be sent when fetching the access token |
Username | The username that should be used (only for password flow) |
Password | The password that should be used (only for password flow) |
Don’t forget to click “Save“
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 CPu notification setup and those of other API's.
Select a notification channel for CPu
Go to Data User and select the CPu 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).
Console CPu Overview
Click on the Notifications tab on the right side of the screen.
Console CPu Notifications
Click on the "Add notification" button.
Console Add CPu Notification
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.
Remark:
When you enable the "Filter Notification types", a list of all possible notifications is shown. You can filter up to one parameter. This will allow you to receive only notifications of that typeset to your channel. Please be advised that for CPu, all possible "ReleaseLight" notifications will be sent to your channel if you would select this value. Possible types are explained in the CPu documentation.
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.
You have now successfully added a notification channel for Certified Pick up.
What’s next?
Need any further assistance?