WebSocket Channels

Channel 1. Receive order updates using the order ID.

Channel Name: ${END_CUSTOMER_ORDER_ID}

This is the public WebSocket channel where you can track the order by entering the order id in the channel name.

Channel 2. Receive order updates using your API KEY and partnerOrderId.

Channel Name: ${API_KEY}_${partnerOrderId}

This is the public WebSocket channel where you can track the order by entering your API key & your order id (partnerOrderId). To use this method, You have to generate a unique order id and pass it as partnerOrderId field as a query parameter before opening our widget.

Channel 3. Receive all the orders updates using your API KEY & Access Token.

Channel Name: ${API_KEY}

This is the private WebSocket channel where you can track all the orders using your API_KEY & ACCESS_TOKEN. We send the WebSocket payload in an encrypted format.
You have to decrypt it using your ACCESS_TOKEN. You can use the jsonwebtoken npm library to decrypt the payload data.

โ—๏ธ

Attention

Listen to this WebSocket using your backend app otherwise your Access Token will get compromised.