What is PortalData Export?
PortalData is a webhook that can be set up to trigger an export whenever an event is added to a package or shipment.
Behind the scenes, all events are checked, and if one matches an Export Profile, the connected Gateway is triggered with the relevant data.
The matching criteria can be anything related to a shipment, such as InstallationId, Event Types, or specific shipment details.
Exports can be triggered either when an event is added or at regular intervals.
Intervals are usually used to summarize information over a set period, with a maximum of 24 hours.
Events Origin
-
On-premises / Ship Cloud/ Shipment Server
Example: "Print" or "Transmit" -
nShift Portal
Events added using the Shipment Viewer -
Scan App
Signature and image can also be exported -
Carrier
Return data events such as "Delivered" -
ClientData
Files from the customer
Export Gateways
-
Email
Only clear text -
SMS
If more than 160 characters, it will be handled as an extra SMS -
FTP
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. -
HTTP
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
Export Profiles
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:
- The 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