Notification Flow

Owned by Shivani Verma (Unlicensed)
Nov 03, 2022
2 min read

  • The client can opt for the RMS notifications to be pushed to their system. 

  • What happens is the logistic aggregator pushes various tracking updates to RMS related to the shipment that was packed in the forward flow as well as return orders created via RMS or logistic aggregator plugins (Eg- Clickpost provides a return order plugin which can be used on the client’s website where a customer can place a return order)

  • These tracking updates are consumed by RMS and corresponding to these updates, notifications are pushed to the client’s system.

  • The client’s system’s url and credentials are configured on the Push Config section on RMS UI. 

  • So when the tracking updates are pushed to RMS, the notification API call is made to the url configured, with the credentials configured in RMS UI passed as http headers.

  • For tracking updates to be consumed by RMS, the RMS url has to be configured on the logistic aggregator panel

    • Clickpost: 

      • Go to the Clickpost settings page

      • Select the Notification tab.

      • Go to the Webhooks: Selected status section

      • There the client can select which all statuses to be pushed to RMS. The same statuses will be pushed by RMS to the client’s system.

      • In the same page, the client has to configure RMS’s url in the webhook url. RMS Clickpost Notification URL: https://saas.increff.com/rms/in/api/clickpost/notify

      • The generated key displayed on this page here has to be set as the webhook key on RMS UI.

    • Shiprocket;

      • Go to the Shiprocket settings page

      • In the API section go to Webhooks

      • Type in the RMS’s url in the URL field. RMS Shiprocket Notification URL:https://saas.increff.com/rms/in/api/st/notify

      • Whatever has been set as webhook key on the RMS UI for Shiprocket will have to be set in the token field.

    • Shipway

      • The RMS’s url would have to be sent to Shipway team. It will be configured at their end. RMS Shipway Notification URL: https://saas.nextscm.com/rms/in/api/shipway/notify

      • Once Shipway team configures the RMS notification url at their end, the notifications will start getting pushed to RMS.