What is PortalData Export?
PortalData is a webhook and can be configured to trigger an export based on an event added to a package/shipment.
In the background, all events are filtered and if one matches an Export Profile then the attached Gateway is triggered with the wanted data.
The criteria for a match can be anything found on a shipment. E.g InstallationId, Event Types, or even Shipment-specific data
An export can be triggered when an event is added, or at an interval.
Interval is normally used if one needs to summarize information based on the period of the interval. Max 24 hours.
On-premises / Ticket / Shipment Server
Example: Print or Transmit
Events added using the Shipment Viewer
Signature and image can also be exported
ReturnData events like delivered
Files from the customer
Only clear text
If more than 160 characters, it will be handled as an extra SMS
Both FTP and SFTP are supported. We can send our standard format, a customized file, or an unprocessed file, with all the data we have on each event if you want to do the data processing on your side.
Support POST requests against a single endpoint.
API-Header authentication is supported using basic authentication, bearer (token) based authentication, and custom header (key+value).
PortalData Export Overview
Only nShift employees can currently create and edit profiles.
How to get started
Submit a request to customer service.
The ticket should include the following information:
- Which type of Gateway(s) you want (email, SMS, FTP, or HTTP)
- Which event(s) should we trigger an export on
- Example of the template we should create using Email/SMS/File
Documentation of the API if you want to use the HTTP gateway
An example of a POST request, including headers and the payload.
Provide the HTTP endpoint. nShift can support:
- API Key/Token: A unique identifier (string)
- OAuth: token-based authentication (client id and secret - JSON Web Token)
- Basic authentication: usernames and passwords.
For more information on the standard format and examples, see